1
1
mirror of https://github.com/twentyhq/twenty.git synced 2024-12-21 02:41:33 +03:00
twenty/docs/docusaurus.config.js

114 lines
3.6 KiB
JavaScript
Raw Normal View History

2023-04-19 11:47:23 +03:00
// @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 = {
2023-04-20 18:35:16 +03:00
title: 'Twenty - Documentation',
tagline: 'Twenty is cool',
favicon: 'img/logo-square-dark.ico',
2023-04-19 11:47:23 +03:00
// Prevent search engines from indexing the doc for selected environments
noIndex: process.env.SHOULD_INDEX_DOC === 'false',
2023-04-19 11:47:23 +03:00
// Set the production url of your site here
url: 'https://docs.twenty.com',
// Set the /<baseUrl>/ pathname under which your site is served
// For GitHub pages deployment, it is often '/<projectName>/'
baseUrl: '/',
onBrokenLinks: 'throw',
onBrokenMarkdownLinks: 'warn',
headTags: [],
2023-04-19 11:47:23 +03:00
// 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'),
sidebarCollapsible: false,
routeBasePath: '/',
editUrl: 'https://github.com/twentyhq/twenty/edit/main/docs/docs/',
2023-04-19 11:47:23 +03:00
},
blog: false,
2023-04-19 11:47:23 +03:00
theme: {
customCss: require.resolve('./src/css/custom.css'),
},
}),
]
2023-04-19 11:47:23 +03:00
],
themeConfig:
/** @type {import('@docusaurus/preset-classic').ThemeConfig} */
({
// Replace with your project's social card
image: 'img/social-card.png',
2023-04-19 11:47:23 +03:00
navbar: {
2023-04-20 23:57:55 +03:00
/*title: 'Twenty',*/
2023-04-19 11:47:23 +03:00
logo: {
2023-04-20 23:57:55 +03:00
alt: 'Twenty',
src: 'img/logo-square-dark.svg',
srcDark: 'img/logo-square-light.svg',
2023-04-19 11:47:23 +03:00
},
items: [
2023-04-20 19:11:55 +03:00
{
type: 'search',
position: 'left',
},
2023-04-19 11:47:23 +03:00
{
to: '/graphql/',
label: 'GraphQL Playground',
position: 'right'
2023-04-19 11:47:23 +03:00
},
{
2023-04-20 18:35:16 +03:00
to: 'https://github.com/twentyhq/twenty/releases',
label: 'Releases',
2023-04-20 19:11:55 +03:00
position: 'right'
}
2023-04-19 11:47:23 +03:00
],
},
2023-04-20 19:11:55 +03:00
algolia: {
appId: 'J2OX2P2QAO',
apiKey: 'e0a7a59c7862598a0cf87307c8ea97f2',
indexName: 'twenty',
2023-04-20 19:11:55 +03:00
// Optional: see doc section below
contextualSearch: true,
// Optional: Specify domains where the navigation should occur through window.location instead on history.push. Useful when our Algolia config crawls multiple documentation sites and we want to navigate with window.location.href to them.
// externalUrlRegex: 'external\\.com|domain\\.com',
2023-04-20 19:11:55 +03:00
// Optional: Replace parts of the item URLs from Algolia. Useful when using the same search index for multiple deployments using a different baseUrl. You can use regexp or string in the `from` param. For example: localhost:3000 vs myCompany.com/docs
/* replaceSearchResultPathname: {
2023-04-20 19:11:55 +03:00
from: '/docs/', // or as RegExp: /\/docs\//
to: '/',
},*/
2023-04-20 19:11:55 +03:00
// Optional: Algolia search parameters
searchParameters: {},
// Optional: path for search page that enabled by default (`false` to disable it)
searchPagePath: 'search',
},
2023-04-20 18:35:16 +03:00
/* footer: {
copyright: `© ${new Date().getFullYear()} Twenty. Docs generated with Docusaurus.`,
},*/
2023-04-19 11:47:23 +03:00
prism: {
theme: lightCodeTheme,
darkTheme: darkCodeTheme,
},
}),
};
module.exports = config;