Doc addition & changes (#2152)
* refactored Storybook UI * refactored Storybook UI * removed extra cards from the doc, added card for ui components * added hover behavior to doc page & made it look selected * separate storybook docs and tests * separating storybook tests and docs * fixed spelling errors in docs * Final round of edits for frontend, added backend folder architecture * Created CODE_OF_CONDUCT.md * Add code of conduct to contributing.md * doc changes * fixed broken links * doc addition and changes
This commit is contained in:
@ -7,20 +7,20 @@ const darkCodeTheme = require('prism-react-renderer/themes/dracula');
|
||||
|
||||
/** @type {import('@docusaurus/types').Config} */
|
||||
const config = {
|
||||
title: 'Twenty - Documentation',
|
||||
tagline: 'Twenty is cool',
|
||||
favicon: 'img/logo-square-dark.ico',
|
||||
title: "Twenty - Documentation",
|
||||
tagline: "Twenty is cool",
|
||||
favicon: "img/logo-square-dark.ico",
|
||||
|
||||
// Prevent search engines from indexing the doc for selected environments
|
||||
noIndex: process.env.SHOULD_INDEX_DOC === 'false',
|
||||
noIndex: process.env.SHOULD_INDEX_DOC === "false",
|
||||
|
||||
// Set the production url of your site here
|
||||
url: 'https://docs.twenty.com',
|
||||
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',
|
||||
baseUrl: "/",
|
||||
onBrokenLinks: "throw",
|
||||
onBrokenMarkdownLinks: "warn",
|
||||
|
||||
headTags: [],
|
||||
|
||||
@ -28,67 +28,73 @@ const config = {
|
||||
// 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'],
|
||||
defaultLocale: "en",
|
||||
locales: ["en"],
|
||||
},
|
||||
presets: [
|
||||
[
|
||||
'classic',
|
||||
"classic",
|
||||
/** @type {import('@docusaurus/preset-classic').Options} */
|
||||
({
|
||||
docs: {
|
||||
breadcrumbs: false,
|
||||
sidebarPath: require.resolve('./sidebars.js'),
|
||||
sidebarPath: require.resolve("./sidebars.js"),
|
||||
sidebarCollapsible: false,
|
||||
routeBasePath: '/',
|
||||
editUrl: 'https://github.com/twentyhq/twenty/edit/main/docs/',
|
||||
routeBasePath: "/",
|
||||
editUrl: "https://github.com/twentyhq/twenty/edit/main/docs/",
|
||||
|
||||
},
|
||||
blog: false,
|
||||
theme: {
|
||||
customCss: require.resolve('./src/css/custom.css'),
|
||||
customCss: require.resolve("./src/css/custom.css"),
|
||||
},
|
||||
}),
|
||||
|
||||
]
|
||||
],
|
||||
],
|
||||
|
||||
themeConfig:
|
||||
/** @type {import('@docusaurus/preset-classic').ThemeConfig} */
|
||||
({
|
||||
// Replace with your project's social card
|
||||
image: 'img/social-card.png',
|
||||
colorMode:{
|
||||
defaultMode: 'light'
|
||||
image: "img/social-card.png",
|
||||
colorMode: {
|
||||
defaultMode: "light",
|
||||
},
|
||||
navbar: {
|
||||
/*title: 'Twenty',*/
|
||||
logo: {
|
||||
alt: 'Twenty',
|
||||
src: 'img/logo-square-dark.svg',
|
||||
srcDark: 'img/logo-square-light.svg',
|
||||
alt: "Twenty",
|
||||
src: "img/logo-square-dark.svg",
|
||||
srcDark: "img/logo-square-light.svg",
|
||||
},
|
||||
items: [
|
||||
{
|
||||
type: 'search',
|
||||
position: 'left',
|
||||
type: "search",
|
||||
position: "left",
|
||||
},
|
||||
{
|
||||
to: '/graphql/',
|
||||
label: 'GraphQL Playground',
|
||||
position: 'right'
|
||||
to: "/graphql/",
|
||||
label: "GraphQL Playground",
|
||||
position: "right",
|
||||
},
|
||||
{
|
||||
to: 'https://github.com/twentyhq/twenty/releases',
|
||||
label: 'Releases',
|
||||
position: 'right'
|
||||
}
|
||||
to: "https://github.com/twentyhq/twenty/releases",
|
||||
label: "Releases",
|
||||
position: "right",
|
||||
},
|
||||
{
|
||||
href: "https://github.com/twentyhq/twenty",
|
||||
position: "right",
|
||||
className: "header-github-link",
|
||||
"aria-label": "GitHub repository",
|
||||
},
|
||||
],
|
||||
},
|
||||
algolia: {
|
||||
appId: 'J2OX2P2QAO',
|
||||
apiKey: 'e0a7a59c7862598a0cf87307c8ea97f2',
|
||||
indexName: 'twenty',
|
||||
|
||||
appId: "J2OX2P2QAO",
|
||||
apiKey: "e0a7a59c7862598a0cf87307c8ea97f2",
|
||||
indexName: "twenty",
|
||||
|
||||
// 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.
|
||||
@ -101,7 +107,7 @@ const config = {
|
||||
// Optional: Algolia search parameters
|
||||
searchParameters: {},
|
||||
// Optional: path for search page that enabled by default (`false` to disable it)
|
||||
searchPagePath: 'search',
|
||||
searchPagePath: "search",
|
||||
},
|
||||
/* footer: {
|
||||
copyright: `© ${new Date().getFullYear()} Twenty. Docs generated with Docusaurus.`,
|
||||
|
||||
Reference in New Issue
Block a user