Skip to content

Commit eb1ffae

Browse files
committed
docs: restore watch and drop the stale banner env
Zensical natively supports the watch key; dropping it broke serve live-reload for docs_src/ snippet edits. The deploy-docs banner env only applied to mkdocs-material builds, and the v1.x fallback arm already sets it inline.
1 parent 6ef1f84 commit eb1ffae

2 files changed

Lines changed: 7 additions & 3 deletions

File tree

.github/workflows/deploy-docs.yml

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -50,9 +50,6 @@ jobs:
5050

5151
- name: Build combined docs (v1.x at /, main at /v2/)
5252
run: bash scripts/build-docs.sh site
53-
env:
54-
# Silence mkdocs-material's MkDocs 2.0 warning banner in CI logs.
55-
NO_MKDOCS_2_WARNING: "1"
5653

5754
- name: Configure Pages
5855
uses: actions/configure-pages@45bfe0192ca1faeb007ade9deae92b16b8254a0d # v6.0.0

mkdocs.yml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -164,6 +164,13 @@ markdown_extensions:
164164
custom_checkbox: true
165165
- sane_lists # this means you can start a list from any number
166166

167+
# Zensical natively watches these beyond docs/: page content is assembled
168+
# from src/ (mkdocstrings) and docs_src/ (snippet includes), so serve
169+
# live-reload must react to both.
170+
watch:
171+
- src
172+
- docs_src
173+
167174
# Zensical natively re-implements `search`, `glightbox` and `mkdocstrings`; it
168175
# does not run arbitrary MkDocs plugins or hooks. The former `gen-files`,
169176
# `literate-nav` and `llms_txt` hook are handled by the standalone scripts

0 commit comments

Comments
 (0)