Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 14 additions & 1 deletion docs/userGuide/makingTheSiteSearchable.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,19 @@ You can add a search bar component to your website to allow users to search the
MarkBind now supports [Pagefind](https://pagefind.app/), a static low-bandwidth search library, as a built-in feature. This provides full-text search capabilities without external services.

<box type="info">
This is a <strong>beta</strong> feature and will be refined in future updates. To use it, you must have <code>enableSearch: true</code> in your <code>site.json</code> (this is the default).
This is a <strong>beta</strong> feature and will be refined in future updates. To use it, you explicitly enable it in your <code>site.json</code>. Add the <code>pagefind</code> configuration with <code>enablePagefind: true</code>.

<panel header="Example of `site.json`">

```json
{
"pagefind": {
"enablePagefind": true
}
}
```
</panel>

</box>

<box type="warning">
Expand Down Expand Up @@ -94,6 +106,7 @@ In your `site.json`:
```json
{
"pagefind": {
"enablePagefind": true,
"exclude_selectors": [".algolia-no-index", "[class*='algolia-no-index']"]
}
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -364,6 +364,5 @@ <h1 id="heading-in-footer-should-not-be-indexed">Heading in footer should not be
});

</script>
<script src="/test_site/markbind/js/pagefind-lazyloader.js"></script>

</html>
1 change: 0 additions & 1 deletion packages/cli/test/functional/test_site/expected/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1030,6 +1030,5 @@ <h1 id="heading-in-footer-should-not-be-indexed">Heading in footer should not be
});

</script>
<script src="/test_site/markbind/js/pagefind-lazyloader.js"></script>

</html>
Original file line number Diff line number Diff line change
Expand Up @@ -371,6 +371,5 @@ <h1 id="heading-in-footer-should-not-be-indexed">Heading in footer should not be
});

</script>
<script src="/test_site/markbind/js/pagefind-lazyloader.js"></script>

</html>
Original file line number Diff line number Diff line change
Expand Up @@ -362,6 +362,5 @@ <h1 id="heading-in-footer-should-not-be-indexed">Heading in footer should not be
});

</script>
<script src="/test_site/markbind/js/pagefind-lazyloader.js"></script>

</html>
Original file line number Diff line number Diff line change
Expand Up @@ -368,6 +368,5 @@ <h1 id="heading-in-footer-should-not-be-indexed">Heading in footer should not be
});

</script>
<script src="/test_site/markbind/js/pagefind-lazyloader.js"></script>

</html>
Original file line number Diff line number Diff line change
Expand Up @@ -368,6 +368,5 @@ <h1 id="heading-in-footer-should-not-be-indexed">Heading in footer should not be
});

</script>
<script src="/test_site/markbind/js/pagefind-lazyloader.js"></script>

</html>
Original file line number Diff line number Diff line change
Expand Up @@ -362,6 +362,5 @@ <h1 id="heading-in-footer-should-not-be-indexed">Heading in footer should not be
});

</script>
<script src="/test_site/markbind/js/pagefind-lazyloader.js"></script>

</html>
Original file line number Diff line number Diff line change
Expand Up @@ -361,6 +361,5 @@ <h1 id="heading-in-footer-should-not-be-indexed">Heading in footer should not be
});

</script>
<script src="/test_site/markbind/js/pagefind-lazyloader.js"></script>

</html>
Original file line number Diff line number Diff line change
Expand Up @@ -430,6 +430,5 @@ <h1 id="heading-in-footer-should-not-be-indexed">Heading in footer should not be
});

</script>
<script src="/test_site/markbind/js/pagefind-lazyloader.js"></script>

</html>
Original file line number Diff line number Diff line change
Expand Up @@ -541,6 +541,5 @@ <h1 id="heading-in-footer-should-not-be-indexed">Heading in footer should not be
});

</script>
<script src="/test_site/markbind/js/pagefind-lazyloader.js"></script>

</html>
Original file line number Diff line number Diff line change
Expand Up @@ -385,6 +385,5 @@ <h1 id="heading-in-footer-should-not-be-indexed">Heading in footer should not be
});

</script>
<script src="/test_site/markbind/js/pagefind-lazyloader.js"></script>

</html>
Original file line number Diff line number Diff line change
Expand Up @@ -200,6 +200,5 @@
});

</script>
<script src="/test_site/markbind/js/pagefind-lazyloader.js"></script>

</html>
Original file line number Diff line number Diff line change
Expand Up @@ -361,6 +361,5 @@ <h1 id="heading-in-footer-should-not-be-indexed">Heading in footer should not be
});

</script>
<script src="/test_site/markbind/js/pagefind-lazyloader.js"></script>

</html>
Original file line number Diff line number Diff line change
Expand Up @@ -584,6 +584,5 @@ <h1 id="heading-in-footer-should-not-be-indexed">Heading in footer should not be
});

</script>
<script src="/test_site/markbind/js/pagefind-lazyloader.js"></script>

</html>
Original file line number Diff line number Diff line change
Expand Up @@ -367,6 +367,5 @@ <h1 id="heading-in-footer-should-not-be-indexed">Heading in footer should not be
});

</script>
<script src="/test_site/markbind/js/pagefind-lazyloader.js"></script>

</html>
Original file line number Diff line number Diff line change
Expand Up @@ -368,6 +368,5 @@ <h1 id="heading-in-footer-should-not-be-indexed">Heading in footer should not be
});

</script>
<script src="/test_site/markbind/js/pagefind-lazyloader.js"></script>

</html>
Original file line number Diff line number Diff line change
Expand Up @@ -368,6 +368,5 @@ <h1 id="heading-in-footer-should-not-be-indexed">Heading in footer should not be
});

</script>
<script src="/test_site/markbind/js/pagefind-lazyloader.js"></script>

</html>
Original file line number Diff line number Diff line change
Expand Up @@ -372,6 +372,5 @@ <h1 id="heading-in-footer-should-not-be-indexed">Heading in footer should not be
});

</script>
<script src="/test_site/markbind/js/pagefind-lazyloader.js"></script>

</html>
Original file line number Diff line number Diff line change
Expand Up @@ -205,6 +205,5 @@
});

</script>
<script src="/test_site/markbind/js/pagefind-lazyloader.js"></script>

</html>
Original file line number Diff line number Diff line change
Expand Up @@ -202,6 +202,5 @@
});

</script>
<script src="/test_site/markbind/js/pagefind-lazyloader.js"></script>

</html>
Original file line number Diff line number Diff line change
Expand Up @@ -370,6 +370,5 @@ <h1 id="heading-in-footer-should-not-be-indexed">Heading in footer should not be
});

</script>
<script src="/test_site/markbind/js/pagefind-lazyloader.js"></script>

</html>
Original file line number Diff line number Diff line change
Expand Up @@ -204,6 +204,5 @@
});

</script>
<script src="/test_site/markbind/js/pagefind-lazyloader.js"></script>

</html>
Original file line number Diff line number Diff line change
Expand Up @@ -368,6 +368,5 @@ <h1 id="heading-in-footer-should-not-be-indexed">Heading in footer should not be
});

</script>
<script src="/test_site/markbind/js/pagefind-lazyloader.js"></script>

</html>
Original file line number Diff line number Diff line change
Expand Up @@ -452,6 +452,5 @@ <h1 id="heading-in-footer-should-not-be-indexed">Heading in footer should not be
});

</script>
<script src="/test_site/markbind/js/pagefind-lazyloader.js"></script>

</html>
Original file line number Diff line number Diff line change
Expand Up @@ -367,6 +367,5 @@ <h1 id="heading-in-footer-should-not-be-indexed">Heading in footer should not be
});

</script>
<script src="/test_site/markbind/js/pagefind-lazyloader.js"></script>

</html>
Original file line number Diff line number Diff line change
Expand Up @@ -362,6 +362,5 @@ <h1 id="heading-in-footer-should-not-be-indexed">Heading in footer should not be
});

</script>
<script src="/test_site/markbind/js/pagefind-lazyloader.js"></script>

</html>
Original file line number Diff line number Diff line change
Expand Up @@ -368,6 +368,5 @@ <h1 id="heading-in-footer-should-not-be-indexed">Heading in footer should not be
});

</script>
<script src="/test_site/markbind/js/pagefind-lazyloader.js"></script>

</html>
Original file line number Diff line number Diff line change
Expand Up @@ -368,6 +368,5 @@ <h1 id="heading-in-footer-should-not-be-indexed">Heading in footer should not be
});

</script>
<script src="/test_site/markbind/js/pagefind-lazyloader.js"></script>

</html>
Original file line number Diff line number Diff line change
Expand Up @@ -368,6 +368,5 @@ <h1 id="heading-in-footer-should-not-be-indexed">Heading in footer should not be
});

</script>
<script src="/test_site/markbind/js/pagefind-lazyloader.js"></script>

</html>
Original file line number Diff line number Diff line change
Expand Up @@ -368,6 +368,5 @@ <h1 id="heading-in-footer-should-not-be-indexed">Heading in footer should not be
});

</script>
<script src="/test_site/markbind/js/pagefind-lazyloader.js"></script>

</html>
Original file line number Diff line number Diff line change
Expand Up @@ -371,6 +371,5 @@ <h1 id="heading-in-footer-should-not-be-indexed">Heading in footer should not be
});

</script>
<script src="/test_site/markbind/js/pagefind-lazyloader.js"></script>

</html>
Original file line number Diff line number Diff line change
Expand Up @@ -1299,6 +1299,5 @@ <h1 id="heading-in-footer-should-not-be-indexed">Heading in footer should not be
});

</script>
<script src="/test_site/markbind/js/pagefind-lazyloader.js"></script>

</html>
Original file line number Diff line number Diff line change
Expand Up @@ -200,6 +200,5 @@
});

</script>
<script src="/test_site/markbind/js/pagefind-lazyloader.js"></script>

</html>
Original file line number Diff line number Diff line change
Expand Up @@ -627,6 +627,5 @@ <h1 id="heading-in-footer-should-not-be-indexed">Heading in footer should not be
});

</script>
<script src="/test_site/markbind/js/pagefind-lazyloader.js"></script>

</html>
Original file line number Diff line number Diff line change
Expand Up @@ -446,6 +446,5 @@ <h1 id="heading-in-footer-should-not-be-indexed">Heading in footer should not be
});

</script>
<script src="/test_site/markbind/js/pagefind-lazyloader.js"></script>

</html>
Original file line number Diff line number Diff line change
Expand Up @@ -503,6 +503,5 @@ <h1 id="heading-in-footer-should-not-be-indexed">Heading in footer should not be
});

</script>
<script src="/test_site/markbind/js/pagefind-lazyloader.js"></script>

</html>
Original file line number Diff line number Diff line change
Expand Up @@ -368,6 +368,5 @@ <h1 id="heading-in-footer-should-not-be-indexed">Heading in footer should not be
});

</script>
<script src="/test_site/markbind/js/pagefind-lazyloader.js"></script>

</html>
Original file line number Diff line number Diff line change
Expand Up @@ -213,6 +213,5 @@
});

</script>
<script src="/test_site/markbind/js/pagefind-lazyloader.js"></script>

</html>
Original file line number Diff line number Diff line change
Expand Up @@ -376,6 +376,5 @@ <h1 id="heading-in-footer-should-not-be-indexed">Heading in footer should not be
});

</script>
<script src="/test_site/markbind/js/pagefind-lazyloader.js"></script>

</html>
Original file line number Diff line number Diff line change
Expand Up @@ -374,6 +374,5 @@ <h1 id="heading-in-footer-should-not-be-indexed">Heading in footer should not be
});

</script>
<script src="/test_site/markbind/js/pagefind-lazyloader.js"></script>

</html>
Original file line number Diff line number Diff line change
Expand Up @@ -364,6 +364,5 @@ <h1 id="heading-in-footer-should-not-be-indexed">Heading in footer should not be
});

</script>
<script src="/test_site/markbind/js/pagefind-lazyloader.js"></script>

</html>
Original file line number Diff line number Diff line change
Expand Up @@ -364,6 +364,5 @@ <h1 id="heading-in-footer-should-not-be-indexed">Heading in footer should not be
});

</script>
<script src="/test_site/markbind/js/pagefind-lazyloader.js"></script>

</html>
Original file line number Diff line number Diff line change
Expand Up @@ -360,6 +360,5 @@ <h1 id="heading-in-footer-should-not-be-indexed">Heading in footer should not be
});

</script>
<script src="/test_site/markbind/js/pagefind-lazyloader.js"></script>

</html>
Original file line number Diff line number Diff line change
Expand Up @@ -418,6 +418,5 @@ <h1 id="heading-in-footer-should-not-be-indexed">Heading in footer should not be
});

</script>
<script src="/test_site/markbind/js/pagefind-lazyloader.js"></script>

</html>
Original file line number Diff line number Diff line change
Expand Up @@ -376,6 +376,5 @@ <h1 id="heading-in-footer-should-not-be-indexed">Heading in footer should not be
});

</script>
<script src="/test_site/markbind/js/pagefind-lazyloader.js"></script>

</html>
Original file line number Diff line number Diff line change
Expand Up @@ -404,6 +404,5 @@ <h1 id="heading-in-footer-should-not-be-indexed">Heading in footer should not be
});

</script>
<script src="/test_site/markbind/js/pagefind-lazyloader.js"></script>

</html>
Loading
Loading