OpenSourceArk/mkdocs-material
1
0
Fork 0
mirror of https://github.com/squidfunk/mkdocs-material.git synced 2024-06-14 11:52:32 +03:00
Code Issues Packages Projects Releases Wiki Activity

Added note on --dirtyreload flag

Browse Source
This commit is contained in:
squidfunk
2021-10-30 13:29:35 +02:00
parent 6ceef24179
commit a532755fa8
2 changed files with 12 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
docs/creating-your-site.md
View File

@@ -138,9 +138,18 @@ MkDocs includes a live preview server, so you can preview your changes as you
write your documentation. The server will automatically rebuild the site upon write your documentation. The server will automatically rebuild the site upon
saving. Start it with: saving. Start it with:
``` sh
mkdocs serve # (1)
``` ```
mkdocs serve
``` 1. If you have a large documentation project, it might take minutes until
MkDocs has rebuilt all pages for you to preview. If you're only interested
in the current page, the `--dirtyreload` flag will make rebuilds much
faster:
```
mkdocs serve --dirtyreload
```
If you're running Material for MkDocs from within Docker, use: If you're running Material for MkDocs from within Docker, use:

2
docs/customization.md
View File

@@ -263,7 +263,7 @@ npm start
Then, in a second terminal window, start the MkDocs live preview server with: Then, in a second terminal window, start the MkDocs live preview server with:
``` ```
mkdocs serve mkdocs serve --watch-theme
``` ```
Point your browser to [localhost:8000][live preview] and you should see this Point your browser to [localhost:8000][live preview] and you should see this