diff --git a/docs/about_mkdocs.md b/docs/about_mkdocs.md index 098e79c..500df1f 100644 --- a/docs/about_mkdocs.md +++ b/docs/about_mkdocs.md @@ -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 diff --git a/docs/index.md b/docs/index.md index 35ee3a5..45b94b8 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,6 +1,8 @@ # MkDocs Quickstart > 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.