From a028e5c2287780210d21b12a125242917729a3fe Mon Sep 17 00:00:00 2001 From: Michael Currin <18750745+MichaelCurrin@users.noreply.github.com> Date: Sat, 17 Oct 2020 16:55:46 +0200 Subject: [PATCH] docs: Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 65caab1..4b33aa6 100644 --- a/README.md +++ b/README.md @@ -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?