Merge branch 'main' of github.com:holochain/docs-pages

holochain · Feb 29, 2024 · 87c2ff7 · 87c2ff7
2 parents 679b1e9 + 9ad3945
commit 87c2ff7
Show file tree

Hide file tree

Showing 9 changed files with 399 additions and 96 deletions.
diff --git a/README.md b/README.md
@@ -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`

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -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",
@@ -72,6 +72,6 @@
  "uglify-js": "^3.17.4"
  },
  "dependencies": {
- "pagefind": "^0.12.0"
+ "pagefind": "1.0.4"
  }
 }
diff --git a/src/client-side/page-search.ts b/src/client-side/page-search.ts
@@ -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")!;

diff --git a/src/pages/_includes/base-layout.njk b/src/pages/_includes/base-layout.njk
@@ -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 %}
 

diff --git a/src/pages/get-started/index.md b/src/pages/get-started/index.md
@@ -349,7 +349,7 @@ You should see something like:
 
 ::: output-block
 ```text
-holochain_scaffolding_cli 0.1.8
+holochain_scaffolding_cli x.y.z
 The list of subcommands for `hc scaffold`
 
 USAGE:
@@ -535,7 +535,9 @@ Updating crates.io index
  Fetch [===> ] ...
 ```
 :::
- (then after download is done...)
+
+(then after download is done...)
+
 ::: output-block
 ```text
  Downloaded 244 crates (46.7 MB) in 4.27s (largest was `windows` at 11.9 MB)
@@ -687,7 +689,7 @@ After adding the `title` and `content` fields, press <kbd>N</kbd> when asked if
 ::: output-block
 ```text
 Which CRUD functions should be scaffolded (SPACE to select/unselect, ENTER to continue)?
-  Update
+✔ Update
 ✔ Delete
 ```
 :::
@@ -1082,13 +1084,14 @@ Your `App.svelte` file will have three sections:
  import { clientContext } from './contexts';
 
  let client: AppAgentClient | undefined;
+
  let loading = true;
 
- $: client, loading;
 
  onMount(async () => {
- // We pass '' as url because it will dynamically be replaced in launcher environments
- client = await AppAgentWebsocket.connect('', 'forum');
+ // We pass an unused string as the url because it will dynamically be replaced in launcher environments
+ client = await AppAgentWebsocket.connect(new URL('https://UNUSED'), 'forum');
+
  loading = false;
  });