iarv/mkdocs-quickstart
1
0
Fork 0
mirror of https://github.com/MichaelCurrin/mkdocs-quickstart.git synced 2026-05-05 04:52:37 +02:00
Code Issues Packages Projects Releases Wiki Activity

feat: Add badges

Browse Source
This commit is contained in:
Michael Currin
2020-05-03 11:42:56 +02:00
parent b61b9d1a70
commit 15e528c07f
2 changed files with 11 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
docs/about_mkdocs.md
View File

@@ -1,18 +1,23 @@
# 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.
**Links:**
## Resources
- [mkdocs.org](https://www.mkdocs.org) homepage
- [mkdocs/mkdocs](https://github.com/mkdocs/mkdocs) on Github
> "Project documentation with Markdown."
- [MkDocs Wiki](https://github.com/mkdocs/mkdocs/wiki) on Github, covering themes, plugins, recipes and more.
- [mkdocs/mkdocs ![Repo stars](https://img.shields.io/github/stars/mkdocs/mkdocs?style=social)](https://github.com/mkdocs/mkdocs)
- [MkDocs Wiki](https://github.com/mkdocs/mkdocs/wiki) - covering themes, plugins, recipes and more.
## Reasons to use MkDocs