| // @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 = { |
| title: 'Apache Kvrocks', |
| tagline: 'A distributed key value NoSQL database that uses RocksDB as storage engine and is compatible with Redis protocol.', |
| url: 'https://kvrocks.apache.org', |
| baseUrl: '/', |
| onBrokenLinks: 'throw', |
| onBrokenMarkdownLinks: 'throw', |
| favicon: 'img/favicon.ico', |
| |
| plugins: [ |
| [ |
| '@docusaurus/plugin-content-docs', |
| { |
| id: 'community', |
| path: 'community', |
| routeBasePath: 'community', |
| sidebarPath: require.resolve('./sidebarsCommunity.js'), |
| editUrl: 'https://github.com/apache/kvrocks-website/tree/main/', |
| }, |
| ], |
| [ |
| '@docusaurus/plugin-content-docs', |
| { |
| id: 'download', |
| path: 'download', |
| routeBasePath: 'download', |
| sidebarPath: require.resolve('./sidebarsDownload.js'), |
| editUrl: 'https://github.com/apache/kvrocks-website/tree/main/', |
| }, |
| ], |
| [require.resolve("docusaurus-plugin-image-zoom"), {}], |
| ], |
| |
| presets: [ |
| [ |
| 'classic', |
| /** @type {import('@docusaurus/preset-classic').Options} */ |
| ({ |
| docs: { |
| path: 'docs', |
| routeBasePath: "/docs", |
| showLastUpdateAuthor: true, |
| showLastUpdateTime: true, |
| sidebarPath: require.resolve('./sidebars.js'), |
| editUrl: 'https://github.com/apache/kvrocks-website/tree/main/', |
| }, |
| blog: { |
| showReadingTime: true, |
| editUrl: 'https://github.com/apache/kvrocks-website/tree/main/', |
| }, |
| theme: { |
| customCss: require.resolve('./src/css/custom.css'), |
| }, |
| }), |
| ], |
| ], |
| |
| themeConfig: |
| /** @type {import('@docusaurus/preset-classic').ThemeConfig} */ |
| ({ |
| colorMode: { |
| defaultMode: 'light', |
| disableSwitch: true, |
| }, |
| navbar: { |
| title: 'Apache Kvrocks', |
| logo: { |
| alt: 'apache-kvrocks', |
| src: 'img/logo.svg', |
| }, |
| items: [ |
| {type: 'doc', docId: 'getting-started', position: 'right', label: 'Docs'}, |
| {to: '/download', label: 'Download', position: 'right'}, |
| {type: 'doc', docId: 'community', position: 'right', label: 'Community', docsPluginId: 'community'}, |
| {to: '/blog', label: 'Blog', position: 'right'}, |
| {to: '/users', label: 'Users', position: 'right'}, |
| { |
| href: 'https://github.com/apache/kvrocks', |
| position: 'right', |
| className: 'header-github-link', |
| 'aria-label': 'GitHub repository', |
| }, |
| {type: 'search', position: 'right'}, |
| { |
| type: 'dropdown', |
| label: 'ASF', |
| position: 'right', |
| items: [ |
| {label: 'Foundation', to: 'https://www.apache.org/'}, |
| {label: 'License', to: 'https://www.apache.org/licenses/'}, |
| {label: 'Events', to: 'https://www.apache.org/events/current-event.html'}, |
| {label: 'Security', to: 'https://www.apache.org/security/'}, |
| {label: 'Sponsorship', to: 'https://www.apache.org/foundation/sponsorship.html'}, |
| {label: 'Privacy', to: 'https://privacy.apache.org/policies/privacy-policy-public.html'}, |
| {label: 'Thanks', to: 'https://www.apache.org/foundation/thanks.html'} |
| ], |
| }, |
| ], |
| }, |
| footer: { |
| style: 'dark', |
| links: [ |
| { |
| title: 'Docs', |
| items: [ |
| { |
| label: 'Getting started', |
| to: '/docs/getting-started', |
| }, |
| { |
| label: 'Supported commands', |
| to: '/docs/supported-commands', |
| }, |
| { |
| label: 'How to contribute', |
| to: 'community/contributing', |
| } |
| ], |
| }, |
| { |
| title: 'Community', |
| items: [ |
| { |
| label: 'Slack', |
| href: 'https://join.slack.com/t/kvrockscommunity/shared_invite/zt-p5928e3r-OUAK8SUgC8GOceGM6dAz6w', |
| }, |
| { |
| label: 'Issue Tracker', |
| href: 'https://github.com/apache/kvrocks/issues', |
| }, |
| { |
| label: 'Mailing list', |
| href: 'https://lists.apache.org/list.html?dev@kvrocks.apache.org', |
| }, |
| ], |
| }, |
| { |
| title: 'Repositories', |
| items: [ |
| { |
| label: 'Kvrocks', |
| href: 'https://github.com/apache/kvrocks', |
| }, |
| { |
| label: 'Website', |
| href: 'https://github.com/apache/kvrocks-website', |
| }, |
| { |
| label: 'Controller', |
| href: 'https://github.com/apache/kvrocks-controller', |
| }, |
| ], |
| }, |
| ], |
| logo: { |
| height: '128px', |
| alt: 'Apache logo', |
| src: 'img/asf_logo.svg', |
| href: 'https://www.apache.org/' |
| }, |
| copyright: `<div style="text-align: left;"> |
| <div style="border-top: 1px solid #ccc;min-height: 60px;line-height: 20px;text-align: center;font-family: Avenir-Medium,serif;font-size: 14px;color: #999;display: flex;align-items: center;"><span>Copyright © ${new Date().getFullYear()} The Apache Software Foundation. Apache Kvrocks, Kvrocks, and its feather logo are trademarks of The Apache Software Foundation. Redis and its cube logo are registered trademarks of Redis Ltd.</span></div> |
| </div>`, |
| }, |
| prism: { |
| theme: lightCodeTheme, |
| darkTheme: darkCodeTheme, |
| additionalLanguages: ['properties'], |
| }, |
| zoom: { |
| selector: '.markdown :not(em) > img', |
| config: { |
| // options you can specify via https://github.com/francoischalifour/medium-zoom#usage |
| background: { |
| light: 'rgb(255, 255, 255)', |
| dark: 'rgb(50, 50, 50)' |
| } |
| } |
| }, |
| }), |
| |
| themes: [ |
| [ |
| require.resolve("@easyops-cn/docusaurus-search-local"), |
| { |
| hashed: true, |
| indexDocs: true, |
| indexPages: true, |
| language: ["en"], |
| } |
| ], |
| ] |
| }; |
| |
| module.exports = config; |