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:55:46 +02:00
parent 49d6ee84a7
commit 4495bc7ff3
1 changed files with 1 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@@ -58,7 +58,7 @@ 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.
To isolate the MkDocs flow from the rest of your code, you can put the configs and the `docs` folder of content inside the `docs` directory. That means you end up having `docs/docs`, which is okay. Just make sure you select the `/docs` directory when setting up GH Pages.
## Why use MkDocs?