From 388b12328f756fc2368e762f2ead5a1bc70f595f Mon Sep 17 00:00:00 2001 From: "F." Date: Wed, 6 May 2026 12:54:47 +0200 Subject: [PATCH] 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. --- .github/workflows/docs.yml | 8 ++++++++ .nojekyll | 0 2 files changed, 8 insertions(+) create mode 100644 .nojekyll diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 4614af0..b75567e 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -7,6 +7,14 @@ name: docs # * push to main — build + deploy to gh-pages. # * workflow_dispatch — same as push (lets operators # re-publish without a docs change). +# +# REPO SETUP REQUIRED — Settings → Pages → Source must be +# "GitHub Actions" (NOT "Deploy from a branch"). The +# branch-based default runs Jekyll on the main branch and +# fails because docs/ uses MkDocs's `{% include-markdown %}` +# syntax which Jekyll's `include` tag doesn't grok. The +# repo-root `.nojekyll` file is a defensive fallback that +# stops Jekyll from running even if the setting reverts. on: pull_request: diff --git a/.nojekyll b/.nojekyll new file mode 100644 index 0000000..e69de29