Skip to content

Commit

Permalink
odpi#116 update dirtyreload tips from review comments
Browse files Browse the repository at this point in the history
Signed-off-by: Nigel Jones <nigel.l.jones+git@gmail.com>
  • Loading branch information
planetf1 committed Nov 12, 2021
1 parent dddf154 commit 2dccac5
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions site/docs/guides/documentation/guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,11 @@ When contributing to the documentation, you can easily use this to test document
As part of running its generator, MkDocs will automatically warn you if it finds any broken links within your documentation. Pay close attention to these, as the PR merge mechanism for documentation will strictly enforce that no broken links are found in order to merge any changes into the main documentation.

!!! tip "Incremental viewing"
If you have the mkdocs server running as you edit page source, it will detect changed files & rebuild automatically. However this can take a minute or two.
To speed this up to a second or two, use the `--dirtyreload` flag to `mkdocs serve`.
Note that any deleted pages will not be removed.
If you have the mkdocs server running as you edit page source, it will detect changed files and rebuild automatically. However this can take a minute or two.
To speed this up to a second or two, use the `--dirtyreload` flag to `mkdocs serve`.

Note that any deleted pages will not be removed, and some links may break as a result that would otherwise work with a full reload (i.e. navigation structure changes).
[Release notes](https://www.mkdocs.org/about/release-notes/#support-for-dirty-builds-990) for the feature have further information.

!!! warning "Special handling of index.md"
Be aware that the specific theme we use will treat every `index.md` as an index page for a section: these behave in special ways depending on the level of the navigation in which they appear. Unless you mean to create an overview of some section of the navigation, do **not** name your Markdown file `index.md`.
Expand Down

0 comments on commit 2dccac5

Please sign in to comment.