Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Signed-off-by: Nigel Jones nigel.l.jones+git@gmail.com
When developing documentation it's useful to run
mkdocs serve
so that pages can be viewed/tested as one is updatingHowever this rebuild is SLOW - it can take a minute or two, and kicks in at random as pages are updated - usually after a few lines!
By adding the
--dirtyreload
parameter tomkdocs serve
this reload is incremental and reduced to 1-2 seconds.Deleted pages will not get cleaned up, and it's possible mass restructuring could be problematic. However for incremental content authoring (for example I am working on Dojo day 1) it's a real bonus
Added this tip into the documentation guide (open to suggestions on improved wording)