fix: set edit_uri with docs subdir

This commit is contained in:
Michael Currin
2021-06-08 17:58:44 +02:00
parent acd0ac400d
commit 16e004a200
2 changed files with 5 additions and 3 deletions

View File

@@ -18,15 +18,16 @@ This is the simplest MkDocs site you can make:
- `docs/`
- `index.md` - Homepage in the `docs` directory (by default).
- `mkdocs.yml`
- `mkdocs.yml`
- Config at the root - control appearance and navigation of your site.
- See this project's [docs/mkdocs.yml](https://github.com/MichaelCurrin/mkdocs-quickstart/blob/master/docs/mkdocs.yml) file on GitHub.
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.
- `repo_url` - for _Edit on GitHub_ button.
- `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)
### Requirements file

View File

@@ -4,6 +4,7 @@ site_name: MkDocs Quickstart
site_description: Starter template for a MkDocs docs site on GH Pages - including CI
repo_url: https://github.com/MichaelCurrin/mkdocs-quickstart
edit_uri: edit/master/docs/docs
### Build settings ###