mirror of
https://github.com/khoj-ai/khoj.git
synced 2024-12-28 23:28:08 +00:00
210 lines
6 KiB
JavaScript
210 lines
6 KiB
JavaScript
// @ts-check
|
|
// `@type` JSDoc annotations allow editor autocompletion and type checking
|
|
// (when paired with `@ts-check`).
|
|
// There are various equivalent ways to declare your Docusaurus config.
|
|
// See: https://docusaurus.io/docs/api/docusaurus-config
|
|
|
|
import {themes as prismThemes} from 'prism-react-renderer';
|
|
|
|
/** @type {import('@docusaurus/types').Config} */
|
|
const config = {
|
|
title: 'Khoj AI',
|
|
tagline: 'Your Second Brain',
|
|
|
|
staticDirectories: ['assets'],
|
|
|
|
favicon: 'img/favicon-128x128.ico',
|
|
|
|
// Set the production url of your site here
|
|
url: 'https://docs.khoj.dev',
|
|
// Set the /<baseUrl>/ pathname under which your site is served
|
|
// For GitHub pages deployment, it is often '/<projectName>/'
|
|
baseUrl: '/',
|
|
|
|
// GitHub pages deployment config.
|
|
// If you aren't using GitHub pages, you don't need these.
|
|
organizationName: 'khoj-ai', // Usually your GitHub org/user name.
|
|
projectName: 'khoj', // Usually your repo name.
|
|
|
|
onBrokenLinks: 'throw',
|
|
onBrokenMarkdownLinks: 'warn',
|
|
|
|
// Even if you don't use internationalization, you can use this field to set
|
|
// useful metadata like html lang. For example, if your site is Chinese, you
|
|
// may want to replace "en" with "zh-Hans".
|
|
i18n: {
|
|
defaultLocale: 'en',
|
|
locales: ['en'],
|
|
},
|
|
|
|
// Add a widget for Chatwoot for live chat if users need help
|
|
clientModules: [require.resolve('./src/components/ChatwootWidget.js')],
|
|
|
|
presets: [
|
|
[
|
|
'classic',
|
|
/** @type {import('@docusaurus/preset-classic').Options} */
|
|
({
|
|
docs: {
|
|
sidebarPath: './sidebars.js',
|
|
routeBasePath: '/',
|
|
// Please change this to your repo.
|
|
// Remove this to remove the "edit this page" links.
|
|
editUrl:
|
|
'https://github.com/khoj-ai/khoj/tree/master/documentation/',
|
|
},
|
|
blog: {
|
|
showReadingTime: true,
|
|
// Please change this to your repo.
|
|
// Remove this to remove the "edit this page" links.
|
|
editUrl:
|
|
'https://github.com/khoj-ai/khoj/tree/master/documentation/blog/',
|
|
},
|
|
theme: {
|
|
customCss: './src/css/custom.css',
|
|
},
|
|
sitemap: {
|
|
lastmod: 'date',
|
|
changefreq: 'weekly',
|
|
priority: 0.5,
|
|
filename: 'sitemap.xml',
|
|
},
|
|
}),
|
|
],
|
|
],
|
|
themeConfig:
|
|
/** @type {import('@docusaurus/preset-classic').ThemeConfig} */
|
|
({
|
|
image: 'img/khoj_documentation.png',
|
|
metadata: [
|
|
{name: 'og:title', content: 'Docs'},
|
|
{name: 'og:type', content: 'website'},
|
|
{name: 'og:site_name', content: 'Khoj Documentation'},
|
|
{name: 'og:description', content: 'Quickly get started with using or self-hosting Khoj'},
|
|
{name: 'og:url', content: 'https://docs.khoj.dev'},
|
|
{name: 'keywords', content: 'khoj, khoj ai, chatgpt, open source ai, open source, transparent, accessible, trustworthy, hackable, index notes, rag, productivity'}
|
|
],
|
|
navbar: {
|
|
title: 'Khoj',
|
|
logo: {
|
|
alt: 'Khoj AI',
|
|
src: 'img/favicon-128x128.ico',
|
|
},
|
|
items: [
|
|
{
|
|
href: 'https://github.com/khoj-ai/khoj',
|
|
label: 'GitHub',
|
|
position: 'right',
|
|
},
|
|
{
|
|
href: 'https://app.khoj.dev/login',
|
|
label: 'Cloud',
|
|
position: 'right',
|
|
},
|
|
{
|
|
href: 'https://discord.gg/BDgyabRM6e',
|
|
label: 'Discord',
|
|
position: 'right',
|
|
},
|
|
{
|
|
href: 'https://blog.khoj.dev',
|
|
label: 'Blog',
|
|
position: 'right',
|
|
},
|
|
],
|
|
},
|
|
footer: {
|
|
style: 'dark',
|
|
links: [
|
|
{
|
|
title: 'Docs',
|
|
items: [
|
|
{
|
|
label: 'Get Started',
|
|
to: '/',
|
|
},
|
|
{
|
|
label: 'Privacy',
|
|
to: '/privacy',
|
|
},
|
|
{
|
|
label: 'Features',
|
|
to: '/features/all-features',
|
|
},
|
|
{
|
|
label: 'Client Apps',
|
|
to: '/category/clients',
|
|
},
|
|
{
|
|
label: 'Self-Host',
|
|
to: '/get-started/setup',
|
|
},
|
|
{
|
|
label: 'Contribute',
|
|
to: '/contributing/development',
|
|
},
|
|
],
|
|
},
|
|
{
|
|
title: 'Community',
|
|
items: [
|
|
{
|
|
label: 'Discord',
|
|
href: 'https://discord.gg/BDgyabRM6e',
|
|
},
|
|
{
|
|
label: 'LinkedIn',
|
|
href: 'https://www.linkedin.com/company/khoj-ai/'
|
|
},
|
|
{
|
|
label: 'Twitter',
|
|
href: 'https://twitter.com/khoj_ai',
|
|
},
|
|
{
|
|
label: 'GitHub',
|
|
href: 'https://github.com/khoj-ai/khoj/issues',
|
|
},
|
|
{
|
|
label: 'Email',
|
|
href: 'mailto:team@khoj.dev',
|
|
}
|
|
],
|
|
},
|
|
{
|
|
title: 'More',
|
|
items: [
|
|
{
|
|
href: 'https://blog.khoj.dev',
|
|
label: 'Blog',
|
|
},
|
|
{
|
|
label: 'Khoj Cloud',
|
|
href: 'https://app.khoj.dev/login',
|
|
},
|
|
{
|
|
label: 'GitHub',
|
|
href: 'https://github.com/khoj-ai/khoj',
|
|
},
|
|
{
|
|
label: 'Website',
|
|
href: 'https://khoj.dev',
|
|
},
|
|
],
|
|
},
|
|
],
|
|
copyright: `Copyright © ${new Date().getFullYear()} Khoj, Inc.`,
|
|
},
|
|
prism: {
|
|
theme: prismThemes.github,
|
|
darkTheme: prismThemes.dracula,
|
|
},
|
|
algolia: {
|
|
appId: "NBR0FXJNGW",
|
|
apiKey: "8841b34192a28b2d06f04dd28d768017",
|
|
indexName: "khoj",
|
|
contextualSearch: false,
|
|
}
|
|
}),
|
|
};
|
|
|
|
export default config;
|