Skip to content

Commit 1dafe57

Browse files
authored
Merge pull request #113 from hyp3rd/feat/dist-mem-cache
docs(ci): add .nojekyll and clarify GitHub Pages setup requirement
2 parents 2a31e8f + 388b123 commit 1dafe57

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)