Feat/add docs search (#19)

* feat(): enable search on docs * feat(): add title template instead of repeat "- Boros"
txpipe · Feb 10, 2025 · e5ed414 · e5ed414
1 parent 4c0ed45
commit e5ed414
Show file tree

Hide file tree

Showing 13 changed files with 73 additions and 10 deletions.
diff --git a/docs/.gitignore b/docs/.gitignore
@@ -6,4 +6,6 @@
 
 # Ignore all .env files except .env.example
 .env*
-!.env.example
+!.env.example
+
+public/_pagefind
diff --git a/docs/Dockerfile b/docs/Dockerfile
@@ -22,6 +22,7 @@ FROM dependencies-env
 COPY ./package.json ./pnpm-lock.yaml /app/
 COPY --from=production-dependencies-env /app/node_modules /app/node_modules
 COPY --from=build-env /app/.next /app/.next
+COPY --from=build-env /app/public /app/public
 WORKDIR /app
 EXPOSE 3000
 CMD ["pnpm", "start"]
diff --git a/docs/app/configuration/page.mdx b/docs/app/configuration/page.mdx
@@ -1,5 +1,5 @@
 ---
-title: Configuration - Boros
+title: Configuration
 sidebarTitle: Configuration
 asIndexPage: true
 ---

diff --git a/docs/app/design/adrs/001-pipeline/page.md b/docs/app/design/adrs/001-pipeline/page.md
@@ -1,5 +1,5 @@
 ---
-title: Pipeline - Boros Docs
+title: Pipeline
 sidebarTitle: Pipeline
 ---
 

diff --git a/docs/app/design/adrs/002-entry-point/page.md b/docs/app/design/adrs/002-entry-point/page.md
@@ -1,5 +1,5 @@
 ---
-title: Entry point - Boros Docs
+title: Entry point
 sidebarTitle: Entry point
 ---
 

diff --git a/docs/app/design/adrs/003-storage/page.md b/docs/app/design/adrs/003-storage/page.md
@@ -1,5 +1,5 @@
 ---
-title: Storage - Boros Docs
+title: Storage
 sidebarTitle: Storage
 ---
 

diff --git a/docs/app/design/adrs/page.mdx b/docs/app/design/adrs/page.mdx
@@ -1,5 +1,5 @@
 ---
-title: Design Adrs - Boros Docs
+title: Design Adrs
 sidebarTitle: Adrs
 asIndexPage: true
 ---

diff --git a/docs/app/design/page.mdx b/docs/app/design/page.mdx
@@ -1,5 +1,5 @@
 ---
-title: Design - Boros
+title: Design
 sidebarTitle: Design
 asIndexPage: true
 ---

diff --git a/docs/app/installation/docker/page.mdx b/docs/app/installation/docker/page.mdx
@@ -1,5 +1,5 @@
 ---
-title: Docker - Boros
+title: Docker
 sidebarTitle: Docker
 asIndexPage: true
 ---

diff --git a/docs/app/installation/from_source/page.mdx b/docs/app/installation/from_source/page.mdx
@@ -1,5 +1,5 @@
 ---
-title: From Source - Boros
+title: From Source
 sidebarTitle: From Source
 asIndexPage: true
 ---

diff --git a/docs/app/layout.tsx b/docs/app/layout.tsx
@@ -6,6 +6,9 @@ import 'nextra-theme-docs/style.css';
 export const metadata = {
   // Define your metadata here
   // For more information on metadata API, see: https://nextjs.org/docs/app/building-your-application/optimizing/metadata
+  title: {
+    template: '%s - Boros',
+  },
 };
 
 const banner = (

diff --git a/docs/package.json b/docs/package.json
@@ -9,7 +9,8 @@
     "start": "next start",
     "lint": "eslint --cache --cache-location ./node_modules/.cache/eslint .",
     "lint:fix": "eslint . --fix",
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "postbuild": "pagefind --site .next/server/app --output-path public/_pagefind"
   },
   "keywords": [],
   "author": "",
@@ -32,6 +33,7 @@
     "eslint-plugin-import": "^2.31.0",
     "eslint-plugin-react-hooks": "^5.1.0",
     "globals": "^15.14.0",
+    "pagefind": "^1.3.0",
     "typescript": "5.7.3"
   }
 }
diff --git a/docs/pnpm-lock.yaml b/docs/pnpm-lock.yaml