Skip to content

Commit 5d33ab9

Browse files
authored
Merge pull request #81 from n-batalha/fix-live-preview
Add live preview to changes
2 parents f7eb854 + 4be856b commit 5d33ab9

File tree

2 files changed

+10
-2
lines changed

2 files changed

+10
-2
lines changed

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,10 +36,14 @@ We can now install our requirements in the new virtual environment:
3636
```
3737
python3 -m pip install -r requirements.txt
3838
```
39-
Deploy to local server from that root folder:
39+
Run a local server from the root folder:
4040
```
4141
mkdocs serve
4242
```
43+
The server can also detect changes and refresh the pages as you edit them:
44+
```
45+
mkdocs serve --watch docs
46+
```
4347
And it should give you a weburl in the terminal to go to --> http://127.0.0.1:8000
4448

4549
Note: video files are stored in a separate branch named `videos`. This is to make it easier to clone quickly with the command `git clone --depth 1 https://github.com/MiSTer-devel/MkDocs_MiSTer.git`. Thanks to @agg23 for the suggestion.

requirements.txt

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,8 @@ mkdocs-material-extensions
77
mkdocs-minify-plugin
88
mkdocs-redirects
99
mkdocs-rss-plugin
10-
mkdocs-material[imaging]
10+
mkdocs-material[imaging]
11+
12+
# restriction to fix live preview
13+
# https://github.com/mkdocs/mkdocs/issues/4032
14+
click<8.3.0

0 commit comments

Comments
 (0)