Files
mkdocs-quickstart/docs/about_mkdocs.md
2020-05-03 11:17:55 +02:00

804 B

About MkDocs

Reasons to use MkDocs

  • Create an elegant, modern docs site for your project.
  • Create a static site and serve from Github Pages easily.
  • Low-code solution
    • No need to write HTML or learn templating syntax needed
    • Use your existing markdown files as content
    • Configure with a simple YAML file.
  • Customizable.
    • Add custom HTML if you want.
    • Plugins available.
    • Flexible theme choices.
  • Includes search by default.
  • Broken links to files (including from your navbar) will be detected at build time and shown as warnings.

Do I need to know Python?

MkDocs is built in Python (like Sphynx), but you don't have to write Python code. If you setup a Deploy flow right, you don't even have to set it up locally, though then you can't preview.