MkDocs is a fast, simple and downright gorgeous static site generator that's geared towards building project documentation. Documentation source files are written in Markdown, and configured with a single YAML configuration file.
Install, run
pip install mkdocs
cd /somedir
mkdocs new myproject
cd myproject
# to start the mkdocs site at http://localhost:8000
mkdocs serve
# or serve at specific IP & port
mkdocs serve -a x.x.x.x:8001
# or listen to all ip at specific port
mkdocs serve -a *:8001
Configure and customize your site
mkdocs.yml
settingg
default value
Example
site_name: Your Site Name`
MkDocs
site_name: Myfaqbase Docs
site_url:SiteUrl
null
repo_url: YourRepoUrl
null
repo_url: https://github.com/example/repository/
repo_name:
GitHub, Bitbucket or GitLab
edit_uri
# Query string example
edit_uri: '?query=root/path/docs/'
# Hash fragment example
edit_uri: '#root/path/docs/'