diff --git a/docs/docs/tutorial/setup-project.md b/docs/docs/tutorial/setup-project.md index 8f44b2f..9974dc6 100644 --- a/docs/docs/tutorial/setup-project.md +++ b/docs/docs/tutorial/setup-project.md @@ -25,6 +25,7 @@ Notes on fields for the config: - `site_name` - title of your site. - `site_description` - used as a description for SEO and you could use it somewhere in your template. +- `site_url` - now a _required_ field when running a deploy. - `repo_url` - for _Edit on GitHub_ button. See [docs](https://www.mkdocs.org/user-guide/configuration/#repo_url). - `edit_uri` - defaults to `edit/master/docs/`, which includes `docs` directory of markdown files inside your repo root. But, if the site's root is in an outer `docs` directory, then you need to _also_ add that, so paths do not break. e.g. `edit/master/docs/docs`. See [docs](https://www.mkdocs.org/user-guide/configuration/#edit_uri) diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 66f9afa..7a1e5d5 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -2,6 +2,7 @@ site_name: MkDocs Quickstart site_description: Starter template for a MkDocs docs site on GH Pages - including CI +site_url: https://michaelcurrin.github.io/mkdocs-quickstart/ repo_url: https://github.com/MichaelCurrin/mkdocs-quickstart edit_uri: edit/master/docs/docs