Skip to content

Commit a532755

Browse files
committed
Added note on --dirtyreload flag
1 parent 6ceef24 commit a532755

File tree

2 files changed

+12
-3
lines changed

2 files changed

+12
-3
lines changed

docs/creating-your-site.md

+11-2
Original file line numberDiff line numberDiff line change
@@ -138,9 +138,18 @@ MkDocs includes a live preview server, so you can preview your changes as you
138138
write your documentation. The server will automatically rebuild the site upon
139139
saving. Start it with:
140140

141+
``` sh
142+
mkdocs serve # (1)
141143
```
142-
mkdocs serve
143-
```
144+
145+
1. If you have a large documentation project, it might take minutes until
146+
MkDocs has rebuilt all pages for you to preview. If you're only interested
147+
in the current page, the `--dirtyreload` flag will make rebuilds much
148+
faster:
149+
150+
```
151+
mkdocs serve --dirtyreload
152+
```
144153
145154
If you're running Material for MkDocs from within Docker, use:
146155

docs/customization.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -263,7 +263,7 @@ npm start
263263
Then, in a second terminal window, start the MkDocs live preview server with:
264264

265265
```
266-
mkdocs serve
266+
mkdocs serve --watch-theme
267267
```
268268

269269
Point your browser to [localhost:8000][live preview] and you should see this

0 commit comments

Comments
 (0)