mirror of
https://github.com/MichaelCurrin/mkdocs-quickstart.git
synced 2026-03-28 17:42:47 +01:00
Update tutorial.md
This commit is contained in:
@@ -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`
|
||||
|
||||
Reference in New Issue
Block a user