Skip to content

feat: add Algolia DocSearch to documentation site #16

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
felippemsc merged 4 commits into from
Feb 10, 2026
Merged

feat: add Algolia DocSearch to documentation site #16

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
8949946
feat: add Algolia DocSearch to documentation site
felippemsc Feb 10, 2026
66a97b7
feat: put wider search bar in navbar on center
felippemsc Feb 10, 2026
a4106b1
fix: center search bar and disable contextual search filtering
felippemsc Feb 10, 2026
ed39744
feat: restyle DocSearch search bar in navbar
felippemsc Feb 10, 2026
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
10 changes: 10 additions & 0 deletions docusaurus.config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,10 @@ const config: Config = {
target: '_self', // Optional: '_self' opens in same tab, '_blank' opens in new tab
},
items: [
{
type: 'search',
position: 'right',
},
{
href: 'https://github.com/SignedShot',
position: 'right',
Expand Down Expand Up @@ -143,6 +147,12 @@ const config: Config = {
theme: prismThemes.github,
darkTheme: prismThemes.dracula,
},
algolia: {
appId: '06JTGHPWUR',
apiKey: 'd28cbe328c68c3fb8896a7646770d01b',
indexName: 'Documentation Website',
contextualSearch: false,
},
} satisfies Preset.ThemeConfig,
};

Expand Down
37 changes: 37 additions & 0 deletions src/css/custom.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,6 +141,43 @@ h1, h2, h3, h4, h5, h6 {
background: url("data:image/svg+xml,%3Csvg viewBox='0 0 24 24' xmlns='http://www.w3.org/2000/svg'%3E%3Cpath d='M12 0c-6.626 0-12 5.373-12 12 0 5.302 3.438 9.8 8.207 11.387.599.111.793-.261.793-.577v-2.234c-3.338.726-4.033-1.416-4.033-1.416-.546-1.387-1.333-1.756-1.333-1.756-1.089-.745.083-.729.083-.729 1.205.084 1.839 1.237 1.839 1.237 1.07 1.834 2.807 1.304 3.492.997.107-.775.418-1.305.762-1.604-2.665-.305-5.467-1.334-5.467-5.931 0-1.311.469-2.381 1.236-3.221-.124-.303-.535-1.524.117-3.176 0 0 1.008-.322 3.301 1.23.957-.266 1.983-.399 3.003-.404 1.02.005 2.047.138 3.006.404 2.291-1.552 3.297-1.23 3.297-1.23.653 1.653.242 2.874.118 3.176.77.84 1.235 1.911 1.235 3.221 0 4.609-2.807 5.624-5.479 5.921.43.372.823 1.102.823 2.222v3.293c0 .319.192.694.801.576 4.765-1.589 8.199-6.086 8.199-11.386 0-6.627-5.373-12-12-12z'/%3E%3C/svg%3E") no-repeat;
}

/* DocSearch - prominent search bar in navbar (inspired by Django/Pydantic/FastAPI) */
.navbar .DocSearch-Button {
border-radius: 8px;
padding: 0 16px;
width: 280px;
background: var(--ss-cloud);
border: 1px solid var(--ss-smoke);
}

.navbar .DocSearch-Button:hover {
background: var(--ss-smoke);
border-color: var(--ss-steel);
box-shadow: none;
}

.navbar .DocSearch-Button-Placeholder {
font-size: 14px;
}

.navbar .DocSearch-Button .DocSearch-Search-Icon {
color: var(--ss-graphite);
}

[data-theme='dark'] .navbar .DocSearch-Button {
background: rgba(255, 255, 255, 0.08);
border: 1px solid rgba(255, 255, 255, 0.12);
}

[data-theme='dark'] .navbar .DocSearch-Button:hover {
background: rgba(255, 255, 255, 0.14);
border-color: rgba(255, 255, 255, 0.2);
}

[data-theme='dark'] .navbar .DocSearch-Button .DocSearch-Search-Icon {
color: var(--ss-steel);
}

[data-theme='dark'] .header-github-link:before {
background: url("data:image/svg+xml,%3Csvg viewBox='0 0 24 24' xmlns='http://www.w3.org/2000/svg'%3E%3Cpath fill='white' d='M12 0c-6.626 0-12 5.373-12 12 0 5.302 3.438 9.8 8.207 11.387.599.111.793-.261.793-.577v-2.234c-3.338.726-4.033-1.416-4.033-1.416-.546-1.387-1.333-1.756-1.333-1.756-1.089-.745.083-.729.083-.729 1.205.084 1.839 1.237 1.839 1.237 1.07 1.834 2.807 1.304 3.492.997.107-.775.418-1.305.762-1.604-2.665-.305-5.467-1.334-5.467-5.931 0-1.311.469-2.381 1.236-3.221-.124-.303-.535-1.524.117-3.176 0 0 1.008-.322 3.301 1.23.957-.266 1.983-.399 3.003-.404 1.02.005 2.047.138 3.006.404 2.291-1.552 3.297-1.23 3.297-1.23.653 1.653.242 2.874.118 3.176.77.84 1.235 1.911 1.235 3.221 0 4.609-2.807 5.624-5.479 5.921.43.372.823 1.102.823 2.222v3.293c0 .319.192.694.801.576 4.765-1.589 8.199-6.086 8.199-11.386 0-6.627-5.373-12-12-12z'/%3E%3C/svg%3E") no-repeat;
}