mirror of
https://github.com/MichaelCurrin/mkdocs-quickstart.git
synced 2026-07-21 09:02:48 +02:00
docs: Update pages
This commit is contained in:
@@ -1,7 +1,7 @@
|
|||||||
# Advanced
|
# Advanced
|
||||||
> Beyond the basic configuration and content
|
> 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
|
## Navbar nesting
|
||||||
|
|||||||
@@ -6,7 +6,7 @@
|
|||||||
|
|
||||||
1. [Install](installation.md)
|
1. [Install](installation.md)
|
||||||
- `pip install mkdocs`
|
- `pip install mkdocs`
|
||||||
2. [Setup project](setup_project.md)
|
2. [Setup project](setup-project.md)
|
||||||
- `mkdocs new .` or [](https://github.com/MichaelCurrin/mkdocs-quickstart/generate)
|
- `mkdocs new .` or [](https://github.com/MichaelCurrin/mkdocs-quickstart/generate)
|
||||||
3. [Run](usage.md)
|
3. [Run](usage.md)
|
||||||
- `mkdocs serve`
|
- `mkdocs serve`
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
# Usage
|
# Usage
|
||||||
> Build and preview a site locally
|
> 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
|
## Serve docs
|
||||||
@@ -21,13 +21,12 @@ Open URL:
|
|||||||
|
|
||||||
Build docs site to `site` directory. Useful for production build or simulating that locally.
|
Build docs site to `site` directory. Useful for production build or simulating that locally.
|
||||||
|
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
mkdocs build
|
mkdocs build
|
||||||
```
|
```
|
||||||
|
|
||||||
Add this flag to remove stale files when building.
|
Add this flag to build in strict mode.
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
mkdocs build --clean
|
mkdocs build --strict
|
||||||
```
|
```
|
||||||
|
|||||||
Reference in New Issue
Block a user