1
0
Fork 0
mirror of https://github.com/tldr-pages/tldr.git synced 2025-04-23 06:02:08 +02:00
tldr/pages/common/mkdocs.md
2022-10-06 19:23:50 +05:30

20 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`