feat: 🎸 docs (#1561)

added algolia

# Description

Please include a summary of the changes and the related issue. Please
also include relevant motivation and context.

## Checklist before requesting a review

Please delete options that are not relevant.

- [ ] My code follows the style guidelines of this project
- [ ] I have performed a self-review of my code
- [ ] I have commented hard-to-understand areas
- [ ] I have ideally added tests that prove my fix is effective or that
my feature works
- [ ] New and existing unit tests pass locally with my changes
- [ ] Any dependent changes have been merged

## Screenshots (if appropriate):
This commit is contained in:
Stan Girard 2023-11-02 14:42:39 +01:00 committed by GitHub
parent eb079a09b0
commit 3a9b7164b5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 2168 additions and 13839 deletions

View File

@ -1,8 +1,7 @@
// @ts-check
// Note: type annotations allow type checking and IDEs autocompletion
const lightCodeTheme = require('prism-react-renderer/themes/github');
const darkCodeTheme = require('prism-react-renderer/themes/dracula');
/** @type {import('@docusaurus/types').Config} */
const config = {
@ -31,7 +30,6 @@ const config = {
defaultLocale: 'en',
locales: ['en'],
},
plugins: [require.resolve('docusaurus-lunr-search')],
presets: [
[
@ -124,10 +122,28 @@ const config = {
],
copyright: `Copyright © ${new Date().getFullYear()} Quivr`,
},
prism: {
theme: lightCodeTheme,
darkTheme: darkCodeTheme,
algolia: {
// The application ID provided by Algolia
appId: '4CC1BF1YRT',
// Public API key: it is safe to commit it
apiKey: '20034381e8836ebc0eedf3f8b251b0eb',
indexName: 'brain',
// Optional: see doc section below
contextualSearch: true,
// Optional: Algolia search parameters
searchParameters: {},
// Optional: path for search page that enabled by default (`false` to disable it)
searchPagePath: 'search',
//... other Algolia params
},
}),
};

12654
docs/package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@ -14,18 +14,19 @@
"write-heading-ids": "docusaurus write-heading-ids"
},
"dependencies": {
"@docusaurus/core": "2.4.1",
"@docusaurus/preset-classic": "2.4.1",
"@mdx-js/react": "^1.6.22",
"@docusaurus/core": "3.0.0",
"@docusaurus/preset-classic": "3.0.0",
"@docusaurus/theme-search-algolia": "^3.0.0",
"@mdx-js/react": "^3.0.0",
"clsx": "^1.2.1",
"docusaurus-lunr-search": "^3.2.0",
"prism-react-renderer": "^1.3.5",
"react": "^17.0.2",
"react-dom": "^17.0.2",
"prism-react-renderer": "^2.1.0",
"react": "^18.2.0",
"react-dom": "^18.2.0",
"react-icons": "^4.9.0"
},
"devDependencies": {
"@docusaurus/module-type-aliases": "2.4.1"
"@docusaurus/module-type-aliases": "3.0.0"
},
"browserslist": {
"production": [
@ -40,6 +41,6 @@
]
},
"engines": {
"node": ">=16.14"
"node": ">=18.0"
}
}

File diff suppressed because it is too large Load Diff

View File

@ -1,4 +1,3 @@
/* eslint-disable */
export const supportedFileExtensions = [
"txt",
"csv",