mirror of
https://github.com/MichaelCurrin/mkdocs-quickstart.git
synced 2026-08-06 08:53:11 +02:00
Update tutorial.md
This commit is contained in:
+9
-9
@@ -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
|
||||
|
||||
Reference in New Issue
Block a user