Welcome to MkDocs (NAME)

Commands:

  • mkdocs new [dir-name] - Create a new project
  • mkdocs serve - Start the live-reloading docs server.
  • mkdocs build - Build the documentation site

Project layout:

mkdocs.yml      # The configuration file.
docs/
    index.md    # The documentation homepage.
    aws/
        s3-bucket.md
    ...         # Other markdown pages, images and other files

1. Start create MkDocs

  • mkdocs new . - create new mkdocs.yml file
  • mkdocs serve - run server

2. Build site files

  • mkdocs build

Use Theme

  • Local Theme
theme:
    name: readthedocs
    highlightjs: true
    hljs_languages:
        - yaml
        - rust
  • External Themes
  • https://github.com/mkdocs/mkdocs/wiki/MkDocs-Themes
  • Example:
pip install mkdocs-windmill