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
License and Disclaimer
The content on this page is copyright © 2014—present the tldr-pages team and contributors.This page is used with permission under Creative Commons Attribution 4.0 International License.
While we do attempt to make sure content is accurate, there isn't a warranty of any kind.