From 7e5650e2410f9ed60e0e14decee4396989ff0349 Mon Sep 17 00:00:00 2001 From: michaelcurrin Date: Sun, 3 May 2020 09:13:03 +0200 Subject: [PATCH] Update tutorial.md --- docs/tutorial.md | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/docs/tutorial.md b/docs/tutorial.md index f616fa2..3baed9e 100644 --- a/docs/tutorial.md +++ b/docs/tutorial.md @@ -1,11 +1,27 @@ # Tutorial -> How to create a MkDocs site. +> How to create a MkDocs site This is a summary of the tutorial on [mkdocs.org](https://www.mkdocs.org/). +### Basic structure + +This is the simplest MkDocs site you can make, with a config at the root and a homepage in the `docs` directory (default). Usually on `master` branch. + +``` +mkdocs.yml +docs/ + index.md +``` + +The steps below start with that and extend it to more pages. + + ### Setup site + +_Tip: Run `mkdocs new .` to create the start site above and then continue with these steps._ + 1. Create pages. 1. Create `docs` directory. 2. Create `index.md`