29 lines
801 B
Markdown
29 lines
801 B
Markdown
|
|
https://www.mkdocs.org/
|
|
|
|
## Commands
|
|
`mkdocs new [dir-name]` - Create a new project.
|
|
`mkdocs serve` - Start the live-reloading docs server. Goto `http://127.0.0.1:8000` to view WEB pages.
|
|
`mkdocs build` - Build the documentation site.
|
|
`mkdocs build --clean` - Clean the output folder.
|
|
`mkdocs -h` - Print help message and exit.
|
|
|
|
## Theme
|
|
#### Change theme to [mkdocs-material](https://squidfunk.github.io/mkdocs-material/getting-started/)
|
|
1. Install by pip
|
|
```
|
|
pip install mkdocs-material
|
|
```
|
|
2. Modify `mkdocs.yml`
|
|
```
|
|
site_name: RobotRunDoc
|
|
nav:
|
|
- Home: index.md
|
|
- 'User Guide':
|
|
- 'Installation': 'Installation/installation.md'
|
|
- 'APIs': 'APIs/Kong.md'
|
|
- About: about.md
|
|
|
|
theme:
|
|
name: material <-- HERE
|
|
``` |