mirror of https://github.com/CrimsonTome/tldr.git
21 lines
408 B
Markdown
21 lines
408 B
Markdown
|
# mkdocs
|
||
|
|
|
||
|
|
> Project documentation with Markdown.
|
||
|
|
> More information: <https://www.mkdocs.org>.
|
||
|
|
|
||
|
|
- Create a new mkdocs project:
|
||
|
|
|
||
|
|
`mkdocs new {{project_name}}`
|
||
|
|
|
||
|
|
- Serve the project in the current directory using the mkdocs dev-server:
|
||
|
|
|
||
|
|
`mkdocs serve`
|
||
|
|
|
||
|
|
- Build the documentation in the current directory:
|
||
|
|
|
||
|
|
`mkdocs build`
|
||
|
|
|
||
|
|
- Deploy the documentation in the current directory to GitHub pages:
|
||
|
|
|
||
|
|
`mkdocs gh-deploy`
|