add search

EwanLyon · Nov 13, 2023 · eeefb81 · eeefb81
1 parent 4f15305
commit eeefb81
Show file tree

Hide file tree

Showing 11 changed files with 572 additions and 169 deletions.
diff --git a/docs/guides/index.md b/docs/guides/index.md
@@ -37,7 +37,7 @@ The file can be found in the root directory of the project.
 
 [Docusaurus Guide](https://docusaurus.io/docs/create-doc)
 
-To create pages just make a new markdown file (`.md`) in the `docs/` folder.
+To create pages make a new text file with the file extension `.md` in the `docs/` folder.
 
 To create nested pages create a folder and add the file there.
 

diff --git a/docs/guides/markdown-guide.md b/docs/guides/markdown-guide.md
@@ -26,7 +26,7 @@ Here's a quick [Markdown Cheat Sheet](https://www.markdownguide.org/cheat-sheet/
 
 \[Another link to a doc page](./folder/another-doc.md)
 
-\[A link to a url](https://google.com/)
+\[A link to a website](https://google.com/)
 
 ### Text style
 
@@ -36,7 +36,7 @@ Here's a quick [Markdown Cheat Sheet](https://www.markdownguide.org/cheat-sheet/
 
 ## Admonitions
 
-More details at the [Docusaurus Documentation](https://docusaurus.io/docs/markdown-features/admonitions).
+More details in the [Docusaurus Documentation](https://docusaurus.io/docs/markdown-features/admonitions).
 
 ```markdown
 :::note

diff --git a/docusaurus.config.ts b/docusaurus.config.ts
@@ -2,6 +2,8 @@ import speeddocsConfig from './speedrun-docs.json';
 import type { Config } from '@docusaurus/types';
 import type { Options, ThemeConfig } from '@docusaurus/preset-classic';
 
+import localSearch from "@easyops-cn/docusaurus-search-local";
+
 import { themes as prismThemes } from 'prism-react-renderer';
 
 const optionalNavbarItems: Record<string, any>[] = [];
@@ -57,41 +59,48 @@ const config: Config = {
       } satisfies Options,
     ],
   ],
-  themeConfig:
-    {
-      navbar: {
-        title: `${speeddocsConfig.game} Speedrun Docs`,
-        logo: {
-          alt: 'Speedrun Docs Logo',
-          src: 'img/run-man.svg',
-        },
-        items: [
-          {
-            type: 'docSidebar',
-            sidebarId: 'tutorialSidebar',
-            position: 'left',
-            label: 'Tutorial',
-          },
-          {
-            type: 'docSidebar',
-            sidebarId: 'resourcesSidebar',
-            position: 'left',
-            label: 'Resources',
-          },
-          ...optionalNavbarItems,
-          {
-            href: `https://github.com/${speeddocsConfig.github.username}/${speeddocsConfig.github.projectName}`,
-            position: 'right',
-            className: 'header-github-link',
-            'aria-label': 'GitHub repository',
-          },
-        ],
+  themeConfig: {
+    navbar: {
+      title: `${speeddocsConfig.game} Speedrun Docs`,
+      logo: {
+        alt: 'Speedrun Docs Logo',
+        src: 'img/run-man.svg',
       },
-      prism: {
-        theme: prismThemes.github,
-        darkTheme: prismThemes.dracula,
-      },
-    } satisfies ThemeConfig,
+      items: [
+        {
+          type: 'docSidebar',
+          sidebarId: 'tutorialSidebar',
+          position: 'left',
+          label: 'Tutorial',
+        },
+        {
+          type: 'docSidebar',
+          sidebarId: 'resourcesSidebar',
+          position: 'left',
+          label: 'Resources',
+        },
+        ...optionalNavbarItems,
+        {
+          href: `https://github.com/${speeddocsConfig.github.username}/${speeddocsConfig.github.projectName}`,
+          position: 'right',
+          className: 'header-github-link',
+          'aria-label': 'GitHub repository',
+        },
+      ],
+    },
+    prism: {
+      theme: prismThemes.github,
+      darkTheme: prismThemes.dracula,
+    },
+  } satisfies ThemeConfig,
+  themes: [
+    [
+      localSearch,
+      ({
+        hashed: true,
+      }) satisfies localSearch.PluginOptions
+    ],
+  ]
 };
 
 export default config;