Skip to content

Commit 388b123

Browse files
committed
docs(ci): add .nojekyll and clarify GitHub Pages setup requirement
Add a \`.nojekyll\` file at the repo root to prevent Jekyll from processing the MkDocs-based docs site, which uses \`{% include-markdown %}\` syntax incompatible with Jekyll's \`include\` tag. Extend the \`docs.yml\` workflow header comment to document that the GitHub Pages source must be configured to "GitHub Actions" rather than "Deploy from a branch" to avoid build failures.
1 parent 50b0f03 commit 388b123

2 files changed

Lines changed: 8 additions & 0 deletions

File tree

.github/workflows/docs.yml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,14 @@ name: docs
77
# * push to main — build + deploy to gh-pages.
88
# * workflow_dispatch — same as push (lets operators
99
# re-publish without a docs change).
10+
#
11+
# REPO SETUP REQUIRED — Settings → Pages → Source must be
12+
# "GitHub Actions" (NOT "Deploy from a branch"). The
13+
# branch-based default runs Jekyll on the main branch and
14+
# fails because docs/ uses MkDocs's `{% include-markdown %}`
15+
# syntax which Jekyll's `include` tag doesn't grok. The
16+
# repo-root `.nojekyll` file is a defensive fallback that
17+
# stops Jekyll from running even if the setting reverts.
1018

1119
on:
1220
pull_request:

.nojekyll

Whitespace-only changes.

0 commit comments

Comments
 (0)