Skip to content

Commit

Permalink
feat: add search bar to the docs (#48)
Browse files Browse the repository at this point in the history
  • Loading branch information
fharper authored Oct 10, 2024
1 parent aa16442 commit b9ba761
Show file tree
Hide file tree
Showing 9 changed files with 281 additions and 3 deletions.
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"allContent":{"docusaurus-plugin-content-docs":{"default":{"loadedVersions":[{"versionName":"current","label":"Next","banner":"unreleased","badge":true,"noIndex":false,"className":"docs-version-current","path":"/docs/next","tagsPath":"/docs/next/tags","isLast":false,"sidebarFilePath":"/Users/fharper/Documents/code/k1/colony-docs/sidebars.js","contentPath":"/Users/fharper/Documents/code/k1/colony-docs/docs","contentPathLocalized":"/Users/fharper/Documents/code/k1/colony-docs/i18n/en/docusaurus-plugin-content-docs/current","docs":[{"id":"clusters/index","title":"Clusters","description":"One possibility for the machines discovered by colony is to be able to create new clusters. For now, we only support the CivoStack, but more options will be available in the future. If you have any suggestions, feel free to let us know in the #colony-clusters channel in our Slack community.","source":"@site/docs/clusters/index.md","sourceDirName":"clusters","slug":"/clusters/","permalink":"/docs/next/clusters/","draft":false,"unlisted":false,"tags":[],"version":"current","frontMatter":{},"sidebar":"myAutogeneratedSidebar","previous":{"title":"Colony","permalink":"/docs/next/"},"next":{"title":"Templates","permalink":"/docs/next/templates/"}},{"id":"index","title":"Colony","description":"colony is a bare metal provisioner and data center infrastructure management system. It's a cloud native microservice ecosystem with components hosted in konstruct cloud and other components that will run on your data centers. You need colony if you want to easily manage bare metal OS provisioning and deprovisioning operations in your own data centers.","source":"@site/docs/index.md","sourceDirName":".","slug":"/","permalink":"/docs/next/","draft":false,"unlisted":false,"tags":[],"version":"current","sidebarPosition":1,"frontMatter":{"sidebar_position":1},"sidebar":"myAutogeneratedSidebar","next":{"title":"Clusters","permalink":"/docs/next/clusters/"}},{"id":"templates/index","title":"Templates","description":"Ubuntu Template - Assets","source":"@site/docs/templates/index.md","sourceDirName":"templates","slug":"/templates/","permalink":"/docs/next/templates/","draft":false,"unlisted":false,"tags":[],"version":"current","frontMatter":{},"sidebar":"myAutogeneratedSidebar","previous":{"title":"Clusters","permalink":"/docs/next/clusters/"}}],"drafts":[],"sidebars":{"myAutogeneratedSidebar":[{"type":"doc","id":"index"},{"type":"doc","label":"Clusters","id":"clusters/index"},{"type":"doc","label":"Templates","id":"templates/index"}]}},{"versionName":"0.1","label":"0.1","banner":null,"badge":true,"noIndex":false,"className":"docs-version-0.1","path":"/docs/","tagsPath":"/docs/tags","isLast":true,"routePriority":-1,"sidebarFilePath":"/Users/fharper/Documents/code/k1/colony-docs/versioned_sidebars/version-0.1-sidebars.json","contentPath":"/Users/fharper/Documents/code/k1/colony-docs/versioned_docs/version-0.1","contentPathLocalized":"/Users/fharper/Documents/code/k1/colony-docs/i18n/en/docusaurus-plugin-content-docs/version-0.1","docs":[{"id":"clusters/index","title":"Clusters","description":"One possibility for the machines discovered by colony is to be able to create new clusters. For now, we only support the CivoStack, but more options will be available in the future. If you have any suggestions, feel free to let us know in the #colony-clusters channel in our Slack community.","source":"@site/versioned_docs/version-0.1/clusters/index.md","sourceDirName":"clusters","slug":"/clusters/","permalink":"/docs/clusters/","draft":false,"unlisted":false,"tags":[],"version":"0.1","frontMatter":{},"sidebar":"myAutogeneratedSidebar","previous":{"title":"Colony","permalink":"/docs/"},"next":{"title":"Templates","permalink":"/docs/templates/"}},{"id":"index","title":"Colony","description":"colony is a bare metal provisioner and data center infrastructure management system. It's a cloud native microservice ecosystem with components hosted in konstruct cloud and other components that will run on your data centers. You need colony if you want to easily manage bare metal OS provisioning and deprovisioning operations in your own data centers.","source":"@site/versioned_docs/version-0.1/index.md","sourceDirName":".","slug":"/","permalink":"/docs/","draft":false,"unlisted":false,"tags":[],"version":"0.1","sidebarPosition":1,"frontMatter":{"sidebar_position":1},"sidebar":"myAutogeneratedSidebar","next":{"title":"Clusters","permalink":"/docs/clusters/"}},{"id":"templates/index","title":"Templates","description":"Ubuntu Template - Assets","source":"@site/versioned_docs/version-0.1/templates/index.md","sourceDirName":"templates","slug":"/templates/","permalink":"/docs/templates/","draft":false,"unlisted":false,"tags":[],"version":"0.1","frontMatter":{},"sidebar":"myAutogeneratedSidebar","previous":{"title":"Clusters","permalink":"/docs/clusters/"}}],"drafts":[],"sidebars":{"myAutogeneratedSidebar":[{"type":"doc","id":"index"},{"type":"doc","label":"Clusters","id":"clusters/index"},{"type":"doc","label":"Templates","id":"templates/index"}]}}]}},"docusaurus-plugin-content-pages":{"default":null},"docusaurus-plugin-debug":{},"docusaurus-theme-classic":{},"docusaurus-bootstrap-plugin":{},"docusaurus-mdx-fallback-plugin":{}}}
{"allContent":{"docusaurus-plugin-content-docs":{"default":{"loadedVersions":[{"versionName":"current","label":"Next","banner":"unreleased","badge":true,"noIndex":false,"className":"docs-version-current","path":"/docs/next","tagsPath":"/docs/next/tags","isLast":false,"sidebarFilePath":"/Users/fharper/Documents/code/k1/colony-docs/sidebars.js","contentPath":"/Users/fharper/Documents/code/k1/colony-docs/docs","contentPathLocalized":"/Users/fharper/Documents/code/k1/colony-docs/i18n/en/docusaurus-plugin-content-docs/current","docs":[{"id":"clusters/index","title":"Clusters","description":"One possibility for the machines discovered by colony is to be able to create new clusters. For now, we only support the CivoStack, but more options will be available in the future. If you have any suggestions, feel free to let us know in the #colony-clusters channel in our Slack community.","source":"@site/docs/clusters/index.md","sourceDirName":"clusters","slug":"/clusters/","permalink":"/docs/next/clusters/","draft":false,"unlisted":false,"tags":[],"version":"current","frontMatter":{},"sidebar":"myAutogeneratedSidebar","previous":{"title":"Colony","permalink":"/docs/next/"},"next":{"title":"Templates","permalink":"/docs/next/templates/"}},{"id":"index","title":"Colony","description":"colony is a bare metal provisioner and data center infrastructure management system. It's a cloud native microservice ecosystem with components hosted in konstruct cloud and other components that will run on your data centers. You need colony if you want to easily manage bare metal OS provisioning and deprovisioning operations in your own data centers.","source":"@site/docs/index.md","sourceDirName":".","slug":"/","permalink":"/docs/next/","draft":false,"unlisted":false,"tags":[],"version":"current","sidebarPosition":1,"frontMatter":{"sidebar_position":1},"sidebar":"myAutogeneratedSidebar","next":{"title":"Clusters","permalink":"/docs/next/clusters/"}},{"id":"templates/index","title":"Templates","description":"Ubuntu Template - Assets","source":"@site/docs/templates/index.md","sourceDirName":"templates","slug":"/templates/","permalink":"/docs/next/templates/","draft":false,"unlisted":false,"tags":[],"version":"current","frontMatter":{},"sidebar":"myAutogeneratedSidebar","previous":{"title":"Clusters","permalink":"/docs/next/clusters/"}}],"drafts":[],"sidebars":{"myAutogeneratedSidebar":[{"type":"doc","id":"index"},{"type":"doc","label":"Clusters","id":"clusters/index"},{"type":"doc","label":"Templates","id":"templates/index"}]}},{"versionName":"0.1","label":"0.1","banner":null,"badge":true,"noIndex":false,"className":"docs-version-0.1","path":"/docs/","tagsPath":"/docs/tags","isLast":true,"routePriority":-1,"sidebarFilePath":"/Users/fharper/Documents/code/k1/colony-docs/versioned_sidebars/version-0.1-sidebars.json","contentPath":"/Users/fharper/Documents/code/k1/colony-docs/versioned_docs/version-0.1","contentPathLocalized":"/Users/fharper/Documents/code/k1/colony-docs/i18n/en/docusaurus-plugin-content-docs/version-0.1","docs":[{"id":"clusters/index","title":"Clusters","description":"One possibility for the machines discovered by colony is to be able to create new clusters. For now, we only support the CivoStack, but more options will be available in the future. If you have any suggestions, feel free to let us know in the #colony-clusters channel in our Slack community.","source":"@site/versioned_docs/version-0.1/clusters/index.md","sourceDirName":"clusters","slug":"/clusters/","permalink":"/docs/clusters/","draft":false,"unlisted":false,"tags":[],"version":"0.1","frontMatter":{},"sidebar":"myAutogeneratedSidebar","previous":{"title":"Colony","permalink":"/docs/"},"next":{"title":"Templates","permalink":"/docs/templates/"}},{"id":"index","title":"Colony","description":"colony is a bare metal provisioner and data center infrastructure management system. It's a cloud native microservice ecosystem with components hosted in konstruct cloud and other components that will run on your data centers. You need colony if you want to easily manage bare metal OS provisioning and deprovisioning operations in your own data centers.","source":"@site/versioned_docs/version-0.1/index.md","sourceDirName":".","slug":"/","permalink":"/docs/","draft":false,"unlisted":false,"tags":[],"version":"0.1","sidebarPosition":1,"frontMatter":{"sidebar_position":1},"sidebar":"myAutogeneratedSidebar","next":{"title":"Clusters","permalink":"/docs/clusters/"}},{"id":"templates/index","title":"Templates","description":"Ubuntu Template - Assets","source":"@site/versioned_docs/version-0.1/templates/index.md","sourceDirName":"templates","slug":"/templates/","permalink":"/docs/templates/","draft":false,"unlisted":false,"tags":[],"version":"0.1","frontMatter":{},"sidebar":"myAutogeneratedSidebar","previous":{"title":"Clusters","permalink":"/docs/clusters/"}}],"drafts":[],"sidebars":{"myAutogeneratedSidebar":[{"type":"doc","id":"index"},{"type":"doc","label":"Clusters","id":"clusters/index"},{"type":"doc","label":"Templates","id":"templates/index"}]}}]}},"docusaurus-plugin-content-pages":{"default":null},"docusaurus-plugin-debug":{},"docusaurus-theme-classic":{},"docusaurus-theme-search-typesense":{},"docusaurus-bootstrap-plugin":{},"docusaurus-mdx-fallback-plugin":{}}}
20 changes: 19 additions & 1 deletion .docusaurus/docusaurus.config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,9 @@ export default {
}
]
],
"themes": [
"docusaurus-theme-search-typesense"
],
"themeConfig": {
"navbar": {
"logo": {
Expand Down Expand Up @@ -270,6 +273,22 @@ export default {
}
]
},
"typesense": {
"typesenseCollectionName": "colony",
"typesenseServerConfig": {
"nodes": [
{
"host": "typesense.mgmt-20.kubefirst.com",
"port": 443,
"protocol": "https"
}
],
"apiKey": "bXLafYINyTtPXLo8KeP1znyMUDXtwVUl"
},
"contextualSearch": true,
"typesenseSearchParameters": {},
"searchPagePath": "search"
},
"colorMode": {
"defaultMode": "light",
"disableSwitch": false,
Expand Down Expand Up @@ -308,7 +327,6 @@ export default {
],
"customFields": {},
"plugins": [],
"themes": [],
"scripts": [],
"headTags": [],
"stylesheets": [],
Expand Down
4 changes: 3 additions & 1 deletion .docusaurus/registry.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 5 additions & 0 deletions .docusaurus/routes.js
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,11 @@ export default [
component: ComponentCreator('/docs/__docusaurus/debug/routes', '13e'),
exact: true
},
{
path: '/docs/search',
component: ComponentCreator('/docs/search', '3e9'),
exact: true
},
{
path: '/docs/',
component: ComponentCreator('/docs/', 'c46'),
Expand Down
6 changes: 6 additions & 0 deletions .docusaurus/routesChunkNames.json
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,12 @@
"plugin": "plugin---docs-docusaurus-debugb-38-c84"
}
},
"/docs/search-3e9": {
"__comp": "__comp---theme-search-page-1-a-4-d6f",
"__context": {
"plugin": "plugin---docs-searche-99-e77"
}
},
"/docs/-c46": {
"__comp": "__comp---theme-docs-root-5-e-9-0b6",
"__context": {
Expand Down
5 changes: 5 additions & 0 deletions .docusaurus/site-metadata.json
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,11 @@
"type": "package",
"name": "@docusaurus/theme-classic",
"version": "3.5.2"
},
"docusaurus-theme-search-typesense": {
"type": "package",
"name": "docusaurus-theme-search-typesense",
"version": "0.22.0"
}
}
}
18 changes: 18 additions & 0 deletions docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,10 @@ const config = {
],
],

themes: [
'docusaurus-theme-search-typesense'
],

themeConfig:
/** @type {import('@docusaurus/preset-classic').ThemeConfig} */
({
Expand Down Expand Up @@ -81,6 +85,20 @@ const config = {
theme: prismThemes.github,
darkTheme: prismThemes.dracula,
},
typesense: {
typesenseCollectionName: 'colony',
typesenseServerConfig: {
nodes: [
{
host: 'typesense.mgmt-20.kubefirst.com',
port: 443,
protocol: 'https',
},
],
apiKey: 'bXLafYINyTtPXLo8KeP1znyMUDXtwVUl',
},
contextualSearch: true,
},
}),
};

Expand Down
Loading

0 comments on commit b9ba761

Please sign in to comment.