Skip to content

wire up algolia search for prod build with necessary env vars #308

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

Merged
heskew merged 1 commit into from
Sep 11, 2025
Merged

wire up algolia search for prod build with necessary env vars #308

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 3 additions & 0 deletions .github/workflows/deploy.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,9 @@ jobs:
DOCUSAURUS_ROUTE_BASE_PATH: ${{ vars.DOCUSAURUS_ROUTE_BASE_PATH }}
DOCUSAURUS_BASE_URL: ${{ vars.DOCUSAURUS_BASE_URL }}
DOCUSAURUS_URL: ${{ vars.DOCUSAURUS_URL }}
ALGOLIA_APP_ID: ${{ secrets.ALGOLIA_APP_ID }}
ALGOLIA_SEARCH_KEY: ${{ secrets.ALGOLIA_SEARCH_KEY }}
ALGOLIA_INDEX_NAME: ${{ secrets.ALGOLIA_INDEX_NAME }}
Copy link
Member Author

@heskew heskew Sep 10, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

not really a secret but it felt better to keep this close to the other algolia vars

run: |
echo "Building Docusaurus site..."
echo "Using DOCUSAURUS_ROUTE_BASE_PATH: $DOCUSAURUS_ROUTE_BASE_PATH"
Expand Down
43 changes: 28 additions & 15 deletions docusaurus.config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -230,21 +230,25 @@ const config: Config = {
],

themes: [
[
require.resolve('@easyops-cn/docusaurus-search-local'),
{
hashed: true,
language: ['en'],
indexDocs: true,
indexBlog: false,
indexPages: false,
docsRouteBasePath: routeBasePath,
highlightSearchTermsOnTargetPage: true,
searchResultLimits: 8,
// Explicitly set the search bar position
searchBarPosition: 'right',
},
],
// Use Algolia search in production when env vars are set, otherwise use local search
...(process.env.NODE_ENV === 'production' && process.env.ALGOLIA_APP_ID && process.env.ALGOLIA_SEARCH_KEY
? ['@docusaurus/theme-search-algolia']
: [
[
require.resolve('@easyops-cn/docusaurus-search-local'),
{
hashed: true,
language: ['en'],
indexDocs: true,
indexBlog: false,
indexPages: true,
docsRouteBasePath: routeBasePath,
highlightSearchTermsOnTargetPage: true,
searchResultLimits: 8,
searchBarPosition: 'right',
},
],
]),
'@docusaurus/theme-mermaid',
],

Expand All @@ -255,6 +259,15 @@ const config: Config = {
themeConfig: {
// Project's social card
image: 'img/HarperOpenGraph.png',
// Algolia search configuration (only used when Algolia theme is active)
algolia: {
appId: process.env.ALGOLIA_APP_ID || '',
apiKey: process.env.ALGOLIA_SEARCH_KEY || '',
indexName: process.env.ALGOLIA_INDEX_NAME || 'harper-docs',
contextualSearch: true,
searchPagePath: 'search',
searchParameters: {},
},
navbar: {
logo: {
alt: 'Harper Logo',
Expand Down
35 changes: 18 additions & 17 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.

35 changes: 18 additions & 17 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,25 +20,26 @@
"lint": "echo 0;"
},
"dependencies": {
"@docusaurus/core": "^3.8.1",
"@docusaurus/plugin-client-redirects": "^3.8.1",
"@docusaurus/preset-classic": "^3.8.1",
"@docusaurus/remark-plugin-npm2yarn": "^3.8.1",
"@docusaurus/theme-mermaid": "^3.8.1",
"@easyops-cn/docusaurus-search-local": "^0.52.1",
"@mdx-js/react": "^3.0.0",
"clsx": "^2.0.0",
"prism-react-renderer": "^2.3.0",
"react": "^19.1.1",
"react-dom": "^19.1.1"
"@docusaurus/core": "3.8.1",
"@docusaurus/plugin-client-redirects": "3.8.1",
"@docusaurus/preset-classic": "3.8.1",
"@docusaurus/remark-plugin-npm2yarn": "3.8.1",
"@docusaurus/theme-mermaid": "3.8.1",
"@docusaurus/theme-search-algolia": "3.8.1",
"@easyops-cn/docusaurus-search-local": "0.52.1",
"@mdx-js/react": "3.1.0",
"clsx": "2.1.1",
"prism-react-renderer": "2.4.1",
"react": "19.1.1",
"react-dom": "19.1.1"
},
"devDependencies": {
"@docusaurus/module-type-aliases": "^3.8.1",
"@docusaurus/tsconfig": "^3.8.1",
"@docusaurus/types": "^3.8.1",
"@harperdb/code-guidelines": "^0.0.2",
"prettier": "^3.6.1",
"typescript": "^5.9.2"
"@docusaurus/module-type-aliases": "3.8.1",
"@docusaurus/tsconfig": "3.8.1",
"@docusaurus/types": "3.8.1",
"@harperdb/code-guidelines": "0.0.2",
"prettier": "3.6.1",
"typescript": "5.9.2"
},
"browserslist": {
"production": [
Expand Down