From 0484dbbb364c8ce5ef18390e826edad1099e0f2c Mon Sep 17 00:00:00 2001 From: Michael Currin <18750745+MichaelCurrin@users.noreply.github.com> Date: Tue, 8 Jun 2021 18:16:47 +0200 Subject: [PATCH] docs: update setup-project.md --- docs/docs/tutorial/setup-project.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/tutorial/setup-project.md b/docs/docs/tutorial/setup-project.md index 9974dc6..8d57730 100644 --- a/docs/docs/tutorial/setup-project.md +++ b/docs/docs/tutorial/setup-project.md @@ -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)