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 setup-project.md

Browse Source
This commit is contained in:
Michael Currin
2021-06-08 18:16:47 +02:00
parent 898c72051c
commit 0484dbbb36
1 changed files with 1 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/docs/tutorial/setup-project.md
View File

@@ -25,7 +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.
- `site_url` - now a _required_ field when running a deploy. Include the subpath on the domain. If your site is not ready to be hosted, set this field to an empty string.
- `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)