adam/mkdocs-quickstart
1
0
Fork 0
mirror of https://github.com/MichaelCurrin/mkdocs-quickstart.git synced 2026-08-10 10:52:50 +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
docs/about_mkdocs.md
+9 -4
View File
@@ -1,18 +1,23 @@
# About MkDocs # About MkDocs
## What is 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*. 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. 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.org](https://www.mkdocs.org) homepage
- [mkdocs/mkdocs](https://github.com/mkdocs/mkdocs) on Github - [mkdocs/mkdocs ![Repo stars](https://img.shields.io/github/stars/mkdocs/mkdocs?style=social)](https://github.com/mkdocs/mkdocs)
> "Project documentation with Markdown." - [MkDocs Wiki](https://github.com/mkdocs/mkdocs/wiki) - covering themes, plugins, recipes and more.
- [MkDocs Wiki](https://github.com/mkdocs/mkdocs/wiki) on Github, covering themes, plugins, recipes and more.
## Reasons to use MkDocs ## Reasons to use MkDocs
docs/index.md
+2
View File
@@ -1,6 +1,8 @@
# MkDocs Quickstart # MkDocs Quickstart
> A concise recipe for setting up a MkDocs docs site on Github Pages > A concise recipe for setting up a MkDocs docs site on Github Pages
[![Repo stars](https://img.shields.io/github/stars/MichaelCurrin/mkdocs-quickstart?style=social)](https://github.com/MichaelCurrin/mkdocs-quickstart)
Use the MkDocs (make docs) tool to create build a docs site around markdown docs. Add to an existing project or create a project from scratch. Use the MkDocs (make docs) tool to create build a docs site around markdown docs. Add to an existing project or create a project from scratch.