Files
fun-with-mkdocs/docs/index.md
TGITS f6221505b5 feat(wip_for_article)
WIP for the article
2024-01-28 15:19:51 +01:00

522 B

Fun with MkDocs

The full documentation is available at mkdocs.org.

Quick Cheatsheet

Commands

  • mkdocs new [dir-name] - Create a new project.
  • mkdocs serve - Start the live-reloading docs server.
  • mkdocs build - Build the documentation site.
  • mkdocs -h - Print help message and exit.

Project layout

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