135 lines
3.9 KiB
JavaScript
135 lines
3.9 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';
|
|
|
|
// This runs in Node.js - Don't use client-side code here (browser APIs, JSX...)
|
|
|
|
/** @type {import('@docusaurus/types').Config} */
|
|
const config = {
|
|
title: 'OpenRAG',
|
|
tagline: 'Open Source RAG Platform',
|
|
favicon: 'img/favicon.ico',
|
|
|
|
// Future flags, see https://docusaurus.io/docs/api/docusaurus-config#future
|
|
future: {
|
|
v4: true, // Improve compatibility with the upcoming Docusaurus v4
|
|
},
|
|
|
|
// Set the production url of your site here
|
|
url: 'https://docs.openr.ag',
|
|
// Set the /<baseUrl>/ pathname under which your site is served
|
|
// For GitHub pages deployment, it is often '/<projectName>/'
|
|
baseUrl: process.env.BASE_URL ? process.env.BASE_URL : '/',
|
|
|
|
// Control search engine indexing - set to true to prevent indexing
|
|
noIndex: true,
|
|
|
|
// GitHub pages deployment config.
|
|
// If you aren't using GitHub pages, you don't need these.
|
|
organizationName: 'langflow-ai', // Usually your GitHub org/user name.
|
|
projectName: 'openrag', // 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'],
|
|
},
|
|
|
|
presets: [
|
|
[
|
|
'classic',
|
|
/** @type {import('@docusaurus/preset-classic').Options} */
|
|
({
|
|
docs: {
|
|
sidebarPath: './sidebars.js',
|
|
// Please change this to your repo.
|
|
// Remove this to remove the "edit this page" links.
|
|
editUrl:
|
|
'https://github.com/openrag/openrag/tree/main/docs/',
|
|
routeBasePath: '/',
|
|
// Versioning configuration - see VERSIONING_SETUP.md
|
|
// To enable versioning, uncomment the following lines:
|
|
// lastVersion: 'current',
|
|
// versions: {
|
|
// current: {
|
|
// label: 'Next (unreleased)',
|
|
// path: 'next',
|
|
// },
|
|
// },
|
|
// onlyIncludeVersions: ['current'],
|
|
},
|
|
theme: {
|
|
customCss: './src/css/custom.css',
|
|
},
|
|
}),
|
|
],
|
|
],
|
|
|
|
plugins: [require.resolve('docusaurus-plugin-image-zoom')],
|
|
|
|
themeConfig:
|
|
/** @type {import('@docusaurus/preset-classic').ThemeConfig} */
|
|
({
|
|
// Replace with your project's social card
|
|
// image: 'img/docusaurus-social-card.jpg',
|
|
navbar: {
|
|
// title: 'OpenRAG',
|
|
logo: {
|
|
alt: 'OpenRAG Logo',
|
|
src: "img/logo-openrag-light.svg",
|
|
srcDark: "img/logo-openrag-dark.svg",
|
|
href: '/',
|
|
},
|
|
items: [
|
|
{
|
|
position: "right",
|
|
href: "https://github.com/langflow-ai/openrag",
|
|
className: "header-github-link",
|
|
target: "_blank",
|
|
rel: null,
|
|
'aria-label': 'GitHub repository',
|
|
},
|
|
],
|
|
},
|
|
footer: {
|
|
links: [
|
|
{
|
|
title: null,
|
|
items: [
|
|
{
|
|
html: `<div class="footer-links">
|
|
<span>© ${new Date().getFullYear()} OpenRAG</span>
|
|
</div>`,
|
|
},
|
|
],
|
|
},
|
|
],
|
|
},
|
|
prism: {
|
|
theme: prismThemes.github,
|
|
darkTheme: prismThemes.dracula,
|
|
},
|
|
zoom: {
|
|
selector: '.markdown img',
|
|
background: {
|
|
light: 'rgb(255, 255, 255)',
|
|
dark: 'rgb(50, 50, 50)',
|
|
},
|
|
config: {
|
|
margin: 24,
|
|
scrollOffset: 0,
|
|
},
|
|
},
|
|
}),
|
|
};
|
|
|
|
export default config;
|