Skip to content

Commit

Permalink
README.md: add note about console warnings
Browse files Browse the repository at this point in the history
Signed-off-by: Filip Lewiński <[email protected]>
  • Loading branch information
filipleple committed Oct 21, 2024
1 parent 888a30a commit d1ccc0f
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,11 @@ localhost:12345` (the number is random).
It is crucial at this point to verify that the pages you have changed
render correctly as HTML in local preview.

It is also important to read through the console output after running `mkdocs
serve`. You should definitely eliminate any `WARNING`s related to your
contribution before submitting it for review, and you should consider applying
suggestions marked as `INFO`.

If you want to use a browser for a live preview while you keep making changes,
consider adding `--dirty` flag to `mkdocs serve` command. It limits automatic
regeneration to only changed files and makes browser updates much faster.
Expand Down

0 comments on commit d1ccc0f

Please sign in to comment.