Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Removing Design System from Site Search and updated Pagefind lib #428

Merged
merged 4 commits into from
Feb 27, 2024
Merged

Removing Design System from Site Search and updated Pagefind lib #428

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
e32ee59
Updating pagefind to 1.x.
MatthewNichols Feb 23, 2024
4b6b143
Adding data-pagefind-body attribute to main pages to exclude Design S…
MatthewNichols Feb 23, 2024
4406cb3
Enabling showSubResults in the PageFind UI
MatthewNichols Feb 23, 2024
d4ce1cd
Documenting the site search functionality
MatthewNichols Feb 23, 2024
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
5 changes: 5 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,11 @@ Additionally the following `markdown-it` plugins have been added:
Please note: The closing `:::` is required. Also if you need to nest containers then the outer container gets an additional `:`.
Each container type needs to be configured in `markdown-it-config.js` for examples and to add more. This one provides a lot of flexibility.

## Site search and indexing
The site uses the [Pagefind](https://pagefind.app/) library to index the contents of the site and to find search results upon request.
The documentation is quite good. One thing to note; pages are indexed based on the inclusion of the `data-pagefind-body`
attribute on a page. It is included on all of the main pages (all but the Design System). If you need to remove some or all of a page
from indexing you can use the `data-pagefind-ignore` attribute. See (https://pagefind.app/docs/indexing/) for details.

## Setup for Dev
- `npm install`
Expand Down
183 changes: 116 additions & 67 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
"doc": "docs"
},
"scripts": {
"build:search-index": "npx pagefind --source _site --glob \"**/*.html\"",
"build:search-index": "npx pagefind --site _site --glob \"**/*.html\"",
"build:web": "ELEVENTY_ENV=production npx @11ty/eleventy",
"serve:web": "ELEVENTY_ENV=development npx @11ty/eleventy --serve --incremental",
"serve:web-prod": "ELEVENTY_ENV=production BROWERSYNC=off npx @11ty/eleventy --serve",
Expand Down Expand Up @@ -72,6 +72,6 @@
"uglify-js": "^3.17.4"
},
"dependencies": {
"pagefind": "^0.12.0"
"pagefind": "1.0.4"
}
}
3 changes: 2 additions & 1 deletion src/client-side/page-search.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,8 @@ const PagefindSearchKey = "pagefind-search";
function setupPagefindUI() {
const pagefindUIInstance = new PagefindUI({
element: "#search",
showImages: false
showImages: false,
showSubResults: true
});

const searchInput = window.document.querySelector<HTMLInputElement>("#search .pagefind-ui__search-input")!;
Expand Down
2 changes: 1 addition & 1 deletion src/pages/_includes/base-layout.njk
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<html lang="en">
{% include "parts/head.njk" %}

<body class="{{ pageStyleId }} {{ layoutId }}">
<body class="{{ pageStyleId }} {{ layoutId }}" data-pagefind-body>
{% include "parts/header.njk" %}
{% renderlayoutblock "abovePageWrap" %}{% endrenderlayoutblock %}

Expand Down
4 changes: 2 additions & 2 deletions src/pages/search.njk
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ layout: default-page-layout.njk
pageStyleId: search
---

<link href="/_pagefind/pagefind-ui.css" rel="stylesheet">
<script src="/_pagefind/pagefind-ui.js" type="text/javascript"></script>
<link href="/pagefind/pagefind-ui.css" rel="stylesheet">
<script src="/pagefind/pagefind-ui.js" type="text/javascript"></script>

<div id="search"></div>
<script defer="true" src="/scripts/page-search.js"></script>