mirror of
https://github.com/MiSTer-devel/MkDocs_MiSTer.git
synced 2026-04-19 03:04:38 +00:00
Merge pull request #81 from n-batalha/fix-live-preview
Add live preview to changes
This commit is contained in:
@@ -36,10 +36,14 @@ We can now install our requirements in the new virtual environment:
|
||||
```
|
||||
python3 -m pip install -r requirements.txt
|
||||
```
|
||||
Deploy to local server from that root folder:
|
||||
Run a local server from the root folder:
|
||||
```
|
||||
mkdocs serve
|
||||
```
|
||||
The server can also detect changes and refresh the pages as you edit them:
|
||||
```
|
||||
mkdocs serve --watch docs
|
||||
```
|
||||
And it should give you a weburl in the terminal to go to --> http://127.0.0.1:8000
|
||||
|
||||
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.
|
||||
|
||||
@@ -7,4 +7,8 @@ mkdocs-material-extensions
|
||||
mkdocs-minify-plugin
|
||||
mkdocs-redirects
|
||||
mkdocs-rss-plugin
|
||||
mkdocs-material[imaging]
|
||||
mkdocs-material[imaging]
|
||||
|
||||
# restriction to fix live preview
|
||||
# https://github.com/mkdocs/mkdocs/issues/4032
|
||||
click<8.3.0
|
||||
Reference in New Issue
Block a user