build: add missing site_url field

This commit is contained in:
Michael Currin
2021-06-08 18:15:53 +02:00
parent e5bcc9ac5f
commit 898c72051c
2 changed files with 2 additions and 0 deletions

View File

@@ -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)

View File

@@ -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