From 4be856b553f45331b128d73ec02ca3ff384a1231 Mon Sep 17 00:00:00 2001 From: Nelson Batalha Date: Wed, 19 Nov 2025 19:08:15 +0000 Subject: [PATCH] Make live preview work again --- README.md | 6 +++++- requirements.txt | 6 +++++- 2 files changed, 10 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 2691e43a..bebcc99a 100644 --- a/README.md +++ b/README.md @@ -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. diff --git a/requirements.txt b/requirements.txt index 3dd3ae28..fc9cb550 100644 --- a/requirements.txt +++ b/requirements.txt @@ -7,4 +7,8 @@ mkdocs-material-extensions mkdocs-minify-plugin mkdocs-redirects mkdocs-rss-plugin -mkdocs-material[imaging] \ No newline at end of file +mkdocs-material[imaging] + +# restriction to fix live preview +# https://github.com/mkdocs/mkdocs/issues/4032 +click<8.3.0 \ No newline at end of file