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

docs: Update README.md

Browse Source
This commit is contained in:
Michael Currin
2020-10-17 16:27:29 +02:00
parent d14aca853a
commit b48560c99d
1 changed files with 3 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@@ -20,7 +20,7 @@ A low-code way to setup and host a markdown-based docs site with a professional
[![Sample screenshot](/sample.png)](https://michaelcurrin.github.io/mkdocs-quickstart/)
This project uses the Read the Docs theme as seen above. It comes with MkDocs so you don't need to add to your dependencies. But you can switch to the MkDocs default or install and configure another theme.
This project uses the _Read the Docs_ theme as seen above. It comes with MkDocs so you don't need to add to your dependencies. But you can switch to the MkDocs default or install and configure another theme.
## How to use this project
@@ -58,6 +58,8 @@ This repo also doubles as a template to create a new project from. Click the but
Change the content and theme to suit your needs, based on the tutorial site or the MkDocs site.
To isolate the MkDocs flow from the rest of the code, you can move the docs directory and MkDocs configs both to be inside the docs directory. That means you end up having `docs/docs`. But that is okay. Just make sure you select the `/docs` directory when setting up GH Pages.
## Why use MkDocs?