mirror of
https://github.com/MichaelCurrin/mkdocs-quickstart.git
synced 2026-03-28 17:42:47 +01:00
feat: Add badges
This commit is contained in:
@@ -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 ](https://github.com/mkdocs/mkdocs)
|
||||
- [MkDocs Wiki](https://github.com/mkdocs/mkdocs/wiki) - covering themes, plugins, recipes and more.
|
||||
|
||||
|
||||
## Reasons to use MkDocs
|
||||
|
||||
@@ -1,6 +1,8 @@
|
||||
# MkDocs Quickstart
|
||||
> A concise recipe for setting up a MkDocs docs site on Github Pages
|
||||
|
||||
[](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.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user