platform/docs/docusaurus.config.js
2023-12-30 17:27:06 -08:00

108 lines
3 KiB
JavaScript

// @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: 'Parcelvoy',
tagline: 'Dinosaurs are cool',
favicon: 'img/favicon.ico',
// Set the production url of your site here
url: 'https://docs.parcelvoy.com',
// 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: 'parcelvoy', // Usually your GitHub org/user name.
projectName: 'platform', // Usually your repo name.
onBrokenLinks: 'throw',
onBrokenMarkdownLinks: 'warn',
// Even if you don't use internalization, 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: require.resolve('./sidebars.js'),
// Please change this to your repo.
// Remove this to remove the "edit this page" links.
editUrl:
'https://github.com/parcelvoy/platform/blob/main/docs/',
routeBasePath: '/',
},
theme: {
customCss: require.resolve('./src/css/custom.css'),
},
}),
],
],
themeConfig:
/** @type {import('@docusaurus/preset-classic').ThemeConfig} */
({
image: 'img/og-image.jpg',
navbar: {
title: '',
logo: {
alt: 'Parcelvoy',
src: 'img/parcelvoy.svg',
srcDark: 'img/parcelvoy-light.svg',
},
items: [
{
href: 'https://github.com/parcelvoy/platform',
label: 'GitHub',
position: 'right',
},
],
},
footer: {
style: 'dark',
copyright: `© ${new Date().getFullYear()} Parcelvoy`,
},
prism: {
theme: darkCodeTheme,
darkTheme: darkCodeTheme,
additionalLanguages: ['swift', 'json', 'kotlin'],
},
algolia: {
// The application ID provided by Algolia
appId: '8ZOD0Z0X8I',
// Public API key: it is safe to commit it
apiKey: '0a521d036d0eeb2ac5c8bafbcfe5b830',
indexName: 'parcelvoy',
// 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
},
}),
};
module.exports = config;