diff --git a/docs/tutorial/advanced.md b/docs/tutorial/advanced.md index 9bf55af..a3a4bda 100644 --- a/docs/tutorial/advanced.md +++ b/docs/tutorial/advanced.md @@ -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 diff --git a/docs/tutorial/tldr.md b/docs/tutorial/tldr.md index fa86c9a..3914e95 100644 --- a/docs/tutorial/tldr.md +++ b/docs/tutorial/tldr.md @@ -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` diff --git a/docs/tutorial/usage.md b/docs/tutorial/usage.md index 49a60b0..d8e858e 100644 --- a/docs/tutorial/usage.md +++ b/docs/tutorial/usage.md @@ -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 ```