Skip to content

mkdocs

new

  • New mkdocs projects with boilerplate config
mkdocs new my-project

serve

mkdocs serve

build

  • Generate build into ./site directory
mkdocs build

get-deps

  • Infer the required python dependencies from the configuration file
mkdocs get-deps

gh-deploy

  • Build and push it to the gh-pages branch
mkdocs gh-deploy