back to context overview

mkdocs

List of commands for mkdocs:

- mkdocs
mkdocs:tldr:34803 mkdocs: Build the documentation in the current directory.

$ mkdocs build

try on your machine

explain this command
- mkdocs
mkdocs:tldr:53d63 mkdocs: Serve the project in the current directory using the mkdocs dev-server.

$ mkdocs serve

try on your machine

explain this command
- mkdocs
mkdocs:tldr:59a84 mkdocs: Deploy the documentation in the current directory to GitHub pages.

$ mkdocs gh-deploy

try on your machine

explain this command
- mkdocs
mkdocs:tldr:94e16 mkdocs: Create a new mkdocs project.

$ mkdocs new ${project_name}

try on your machine

explain this command

back to context overview