From d59ed88866ad3e60b804f245c717aac750bd625a Mon Sep 17 00:00:00 2001 From: michaelcurrin Date: Sun, 3 May 2020 09:17:27 +0200 Subject: [PATCH] Update tutorial.md --- docs/tutorial.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/tutorial.md b/docs/tutorial.md index 3baed9e..8752a41 100644 --- a/docs/tutorial.md +++ b/docs/tutorial.md @@ -6,7 +6,7 @@ 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. +This is the simplest MkDocs site you can make, with a config at the root and a homepage in the `docs` directory (by default). Usually on `master` branch. ``` mkdocs.yml @@ -17,18 +17,18 @@ docs/ The steps below start with that and extend it to more pages. +Run `mkdocs new .` to create the starter site above and to make the steps below go quicker. + + ### Setup site - -_Tip: Run `mkdocs new .` to create the start site above and then continue with these steps._ - -1. Create pages. +1. Create docs pages. 1. Create `docs` directory. 2. Create `index.md` - 3. Create other pages. + 3. Create other pages (optional). 2. Setup config. 1. Create `mkdocs.yml` at project root. - 2. Setup navbar in `mkdocs.yml`. + 2. Setup navbar there. e.g. ```yaml nav: - Home: index.md @@ -38,8 +38,8 @@ _Tip: Run `mkdocs new .` to create the start site above and then continue with t ```yaml theme: readthedocs ``` -3. Create a favicon. - - It will be picked up this path: `docs/img/favicon.ico`. +3. Create a favicon (optional). + - It will be picked up at this path: `docs/img/favicon.ico`. ### Further configuration