Skip to content

Commit 7d43fd5

Browse files
committed
Exclude archived release docs from Pagefind index
Update docs build scripts to remove 'data-pagefind-body' from HTML files in _site/releases, preventing archived release documentation from being indexed by Pagefind. This follows Pagefind's recommended approach for excluding pages from the search index. Signed-off-by: Christoph Rueger <[email protected]>
1 parent b2b59aa commit 7d43fd5

File tree

4 files changed

+14
-2
lines changed

4 files changed

+14
-2
lines changed

.github/scripts/docs.sh

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,8 @@ bundle exec jekyll build
88

99
# create search index under _site/pagefind
1010
pwd
11+
# ensure the archived _site/releases docs from former release do not get indexed by pagefind
12+
# by removing the 'data-pagefind-body' from those pages
13+
# see https://pagefind.app/docs/indexing/#removing-pages-from-pagefinds-index
14+
find _site/releases -type f -name "*.html" -exec sed -i 's/data-pagefind-body//g' {} +
1115
./pagefind --verbose --site _site --output-subdir pagefindindex

docs/_includes/searchbox.htm

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -102,8 +102,8 @@
102102

103103

104104

105-
<link href="/pagefindindex/pagefind-ui.css" rel="stylesheet">
106-
<script src="/pagefindindex/pagefind-ui.js"></script>
105+
<link href="{{ '/pagefindindex/pagefind-ui.css' | prepend:site.baseurl }}" rel="stylesheet">
106+
<script src="{{ '/pagefindindex/pagefind-ui.js' | prepend:site.baseurl }}"></script>
107107
<script>
108108
window.addEventListener('DOMContentLoaded', (event) => {
109109
new PagefindUI({

docs/run-pagefind-linux.sh

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,4 +11,8 @@ bundle exec jekyll build
1111
[ -f pagefind.tar.gz ] || curl -L https://github.com/CloudCannon/pagefind/releases/download/v1.3.0/pagefind-v1.3.0-x86_64-unknown-linux-musl.tar.gz -o pagefind.tar.gz
1212
tar xzf pagefind.tar.gz
1313
chmod +x pagefind
14+
# ensure the archived _site/releases docs from former release do not get indexed by pagefind
15+
# by removing the 'data-pagefind-body' from those pages
16+
# see https://pagefind.app/docs/indexing/#removing-pages-from-pagefinds-index
17+
find _site/releases -type f -name "*.html" -exec sed -i 's/data-pagefind-body//g' {} +
1418
./pagefind --site _site --serve --output-subdir pagefindindex

docs/run-pagefind-macos.sh

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,4 +11,8 @@ bundle exec jekyll build
1111
[ -f pagefind.tar.gz ] || curl -L https://github.com/CloudCannon/pagefind/releases/download/v1.3.0/pagefind-v1.3.0-aarch64-apple-darwin.tar.gz -o pagefind.tar.gz
1212
tar xzf pagefind.tar.gz
1313
chmod +x pagefind
14+
# ensure the archived _site/releases docs from former release do not get indexed by pagefind
15+
# by removing the 'data-pagefind-body' from those pages
16+
# see https://pagefind.app/docs/indexing/#removing-pages-from-pagefinds-index
17+
find _site/releases -type f -name "*.html" -exec sed -i '' 's/data-pagefind-body//g' {} +
1418
./pagefind --site _site --serve --output-subdir pagefindindex

0 commit comments

Comments
 (0)