Update tutorial.md

This commit is contained in:
michaelcurrin
2020-05-03 09:13:03 +02:00
committed by GitHub
parent dc05d52b62
commit 7e5650e241

View File

@@ -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`