iarv/mkdocs-quickstart
1
0
Fork 0
mirror of https://github.com/MichaelCurrin/mkdocs-quickstart.git synced 2026-03-28 17:42:47 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs: Update pages

Browse Source
This commit is contained in:
Michael Currin
2020-10-15 10:43:47 +02:00
parent b27fe05ebe
commit c25398473f
3 changed files with 5 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/tutorial/advanced.md
View File

@@ -1,7 +1,7 @@
# Advanced
> Beyond the basic configuration and content
Once you've got the [Setup Project](setup_project.md) section, you can customize further using this guide. Or skip this and go to [Usage](usage.md).
Once you've got the [Setup Project](setup-project.md) section, you can customize further using this guide. Or skip this and go to [Usage](usage.md).
## Navbar nesting

2
docs/tutorial/tldr.md
View File

@@ -6,7 +6,7 @@
1. [Install](installation.md)
- `pip install mkdocs`
2. [Setup project](setup_project.md)
2. [Setup project](setup-project.md)
- `mkdocs new .` or [![Use this template](https://img.shields.io/badge/Use_this_template-green.svg)](https://github.com/MichaelCurrin/mkdocs-quickstart/generate)
3. [Run](usage.md)
- `mkdocs serve`

7
docs/tutorial/usage.md
View File

@@ -1,7 +1,7 @@
# Usage
> Build and preview a site locally
_Note: If using VS Code, you can use the command palette instead to run the configured tasks - these are setup in `.vscode/tasks.json`._
_Note: If using VS Code, you can use the command palette instead to run the configured tasks - these are setup in `.vscode/tasks.json`. However, using a `Makefile` allows more control locally and on for a remote build._
## Serve docs
@@ -21,13 +21,12 @@ Open URL:
Build docs site to `site` directory. Useful for production build or simulating that locally.
```sh
mkdocs build
```
Add this flag to remove stale files when building.
Add this flag to build in strict mode.
```sh
mkdocs build --clean
mkdocs build --strict
```