iarv/mkdocs-quickstart
1
0
Fork 0
mirror of https://github.com/MichaelCurrin/mkdocs-quickstart.git synced 2026-03-28 17:42:47 +01:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
michaelcurrin
2020-09-10 17:35:30 +02:00
committed by GitHub
parent dbc5a5a15e
commit 49b3a80578
1 changed files with 10 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@@ -13,23 +13,24 @@
[![Sample screenshot](/sample.png)](https://michaelcurrin.github.io/mkdocs-quickstart/)
## Features
- Markdown-based docs site which is easy to edit
- Easy to configure without having to write HTML and CSS
- Uses a deploy pipeline on GH Actions to deploy a GH Pages site
## How to use this project
<div align="center">
[![GH pages](https://img.shields.io/badge/Github_Pages-MkDocs_Quickstart-green?style=for-the-badge)](https://michaelcurrin.github.io/mkdocs-quickstart/)
[![GH Pages](https://img.shields.io/badge/Github_Pages-MkDocs_Quickstart-green?style=for-the-badge)](https://michaelcurrin.github.io/mkdocs-quickstart/)
[![Use this template](https://img.shields.io/badge/Use_this_template-2ea44f?style=for-the-badge)](https://github.com/MichaelCurrin/mkdocs-quickstart/generate)
</div>
## Features
- A markdown-based docs site which is easy to edit - see the content [docs](/docs/) directory.
- Easy to configure - see the short [mkdocs.yml](/mkdocs.yml) file.
- Use the configured theme or switch to another - no need to write HTML and CSS.
- Uses a deploy pipeline on GH Actions to deploy a GH Pages site.
### View live demo site
This project has a site deployed to GitHub Pages.