mirror of
https://github.com/ivuorinen/cheatsheet-tldr.git
synced 2026-01-26 11:33:59 +00:00
26 lines
517 B
Plaintext
26 lines
517 B
Plaintext
---
|
|
syntax: markdown
|
|
tags: [tldr, common]
|
|
source: https://github.com/tldr-pages/tldr.git
|
|
---
|
|
# mkdocs
|
|
|
|
> Project documentation with Markdown.
|
|
> More information: <https://www.mkdocs.org/user-guide/cli/>.
|
|
|
|
- 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`
|