mirror of
https://github.com/MichaelCurrin/mkdocs-quickstart.git
synced 2026-03-28 17:42:47 +01:00
42 lines
1.4 KiB
Markdown
42 lines
1.4 KiB
Markdown
# About MkDocs
|
|
|
|
|
|
|
|
## What is MkDocs?
|
|
|
|
The description on the MkDocs site is:
|
|
|
|
> Project documentation with Markdown.
|
|
|
|
MkDocs is a Python tool generates a static site based on content written in *markdown*.
|
|
|
|
If you are new to markdown, see the [Getting Started](https://www.markdownguide.org/getting-started/) page on the Markdown Guide website.
|
|
|
|
|
|
## Resources
|
|
|
|
- [mkdocs.org](https://www.mkdocs.org) homepage
|
|
- [mkdocs/mkdocs ](https://github.com/mkdocs/mkdocs)
|
|
- [MkDocs Wiki](https://github.com/mkdocs/mkdocs/wiki) - covering themes, plugins, recipes and more.
|
|
|
|
|
|
## 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](deloy) flow right, you don't even have to set it up locally, though then you can't preview.
|