---
syntax: markdown
tags: [tldr, common]
source: https://github.com/tldr-pages/tldr.git
---
# 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`
