Skip to content

Commit 51f2a33

Browse files
anaxiteanaxite
committed
chore (config): consolidate markdown config block
There were two markdown blocks. Now there are one.
1 parent 6974b84 commit 51f2a33

File tree

1 file changed

+188
-190
lines changed

1 file changed

+188
-190
lines changed

‎docusaurus.config.ts‎

Lines changed: 188 additions & 190 deletions
Original file line numberDiff line numberDiff line change
@@ -4,201 +4,199 @@ import type * as Preset from "@docusaurus/preset-classic";
44
require("dotenv").config();
55

66
const config: Config = {
7-
title: "Doc Detective",
8-
tagline: "Keep your docs in sync with your product. Always.",
9-
favicon: "img/favicon.ico",
10-
staticDirectories: ["public", "static"],
7+
title: "Doc Detective",
8+
tagline: "Keep your docs in sync with your product. Always.",
9+
favicon: "img/favicon.ico",
10+
staticDirectories: ["public", "static"],
1111

12-
// Set the production url of your site here
13-
url: "https://doc-detective.com",
14-
// Set the /<baseUrl>/ pathname under which your site is served
15-
// For GitHub pages deployment, it is often '/<projectName>/'
16-
baseUrl: "/",
12+
// Set the production url of your site here
13+
url: "https://doc-detective.com",
14+
// Set the /<baseUrl>/ pathname under which your site is served
15+
// For GitHub pages deployment, it is often '/<projectName>/'
16+
baseUrl: "/",
1717

18-
// GitHub pages deployment config.
19-
// If you aren't using GitHub pages, you don't need these.
20-
organizationName: "doc-detective", // Usually your GitHub org/user name.
21-
projectName: "doc-detective.github.io", // Usually your repo name.
22-
trailingSlash: false,
23-
deploymentBranch: "gh-pages",
18+
// GitHub pages deployment config.
19+
// If you aren't using GitHub pages, you don't need these.
20+
organizationName: "doc-detective", // Usually your GitHub org/user name.
21+
projectName: "doc-detective.github.io", // Usually your repo name.
22+
trailingSlash: false,
23+
deploymentBranch: "gh-pages",
2424

25-
onBrokenLinks: "throw",
26-
markdown: {
27-
hooks: {
28-
onBrokenMarkdownLinks: "warn",
29-
},
30-
},
31-
// Even if you don't use internationalization, you can use this field to set
32-
// useful metadata like html lang. For example, if your site is Chinese, you
33-
// may want to replace "en" with "zh-Hans".
34-
i18n: {
35-
defaultLocale: "en",
36-
locales: ["en"],
37-
},
25+
onBrokenLinks: "throw",
26+
markdown: {
27+
mermaid: true,
28+
hooks: {
29+
onBrokenMarkdownLinks: "warn",
30+
},
31+
},
32+
// Even if you don't use internationalization, you can use this field to set
33+
// useful metadata like html lang. For example, if your site is Chinese, you
34+
// may want to replace "en" with "zh-Hans".
35+
i18n: {
36+
defaultLocale: "en",
37+
locales: ["en"],
38+
},
3839

39-
presets: [
40-
[
41-
"classic",
42-
{
43-
docs: {
44-
sidebarPath: "./sidebars.ts",
45-
// Please change this to your repo.
46-
// Remove this to remove the "edit this page" links.
47-
editUrl:
48-
"https://github.dev/doc-detective/doc-detective.github.io/blob/main/",
49-
},
50-
blog: {
51-
showReadingTime: true,
52-
// Please change this to your repo.
53-
// Remove this to remove the "edit this page" links.
54-
editUrl:
55-
"https://github.dev/doc-detective/doc-detective.github.io/blob/main/",
56-
},
57-
theme: {
58-
customCss: "./src/css/custom.css",
59-
},
60-
} satisfies Preset.Options,
61-
],
62-
],
40+
presets: [
41+
[
42+
"classic",
43+
{
44+
docs: {
45+
sidebarPath: "./sidebars.ts",
46+
// Please change this to your repo.
47+
// Remove this to remove the "edit this page" links.
48+
editUrl:
49+
"https://github.dev/doc-detective/doc-detective.github.io/blob/main/",
50+
},
51+
blog: {
52+
showReadingTime: true,
53+
// Please change this to your repo.
54+
// Remove this to remove the "edit this page" links.
55+
editUrl:
56+
"https://github.dev/doc-detective/doc-detective.github.io/blob/main/",
57+
},
58+
theme: {
59+
customCss: "./src/css/custom.css",
60+
},
61+
} satisfies Preset.Options,
62+
],
63+
],
6364

64-
themeConfig: {
65-
// Replace with your project's social card
66-
image: "img/social-card.jpg",
67-
navbar: {
68-
title: "Doc Detective",
69-
logo: {
70-
alt: "Doc Detective Logo",
71-
src: "img/logo.svg",
72-
},
73-
items: [
74-
{
75-
type: "docSidebar",
76-
sidebarId: "docsSidebar",
77-
position: "left",
78-
label: "Get started",
79-
},
80-
{
81-
type: "docSidebar",
82-
sidebarId: "referencesSidebar",
83-
position: "left",
84-
label: "References",
85-
},
86-
// { to: "/app", label: "Action Builder (beta)", position: "left" },
87-
// {to: '/blog', label: 'Blog', position: 'left'},
88-
{ to: "/support", label: "Support ❤️", position: "right" },
89-
{
90-
type: "docSidebar",
91-
sidebarId: "contributeSidebar",
92-
position: "right",
93-
label: "Contribute",
94-
},
95-
{
96-
href: "https://github.com/doc-detective",
97-
label: "GitHub",
98-
position: "right",
99-
},
100-
],
101-
},
102-
footer: {
103-
style: "dark",
104-
links: [
105-
{
106-
title: "Docs",
107-
items: [
108-
{
109-
label: "Get started",
110-
to: "/docs/get-started/intro",
111-
},
112-
],
113-
},
114-
{
115-
title: "Community",
116-
items: [
117-
{
118-
label: "Discord",
119-
href: "https://discord.gg/2M7wXEThfF",
120-
},
121-
{
122-
label: "LinkedIn",
123-
href: "https://www.linkedin.com/company/doc-detective",
124-
},
125-
],
126-
},
127-
{
128-
title: "More",
129-
items: [
130-
// {
131-
// label: 'Blog',
132-
// to: '/blog',
133-
// },
134-
{
135-
label: "GitHub",
136-
href: "https://github.com/doc-detective",
137-
},
138-
],
139-
},
140-
],
141-
copyright: `Copyright © ${new Date().getFullYear()} Doc Detective.`,
142-
},
143-
prism: {
144-
theme: prismThemes.github,
145-
darkTheme: prismThemes.dracula,
146-
},
147-
inkeepConfig: {
148-
baseSettings: {
149-
apiKey: process.env.INKEEP_API_KEY, // required
150-
integrationId: process.env.INKEEP_INTEGRATION_ID, // required
151-
organizationId: process.env.INKEEP_ORGANIZATION_ID, // required
152-
primaryBrandColor: "#00c122", // required -- your brand color, the widget color scheme is derived from this
153-
organizationDisplayName: "Doc Detective", // required -- your organization name
154-
// ...optional settings
155-
theme: {
156-
// stylesheetUrls: ['/path/to/stylesheets'], // optional
157-
syntaxHighlighter: {
158-
lightTheme: prismThemes.github, // optional -- pass in the Prism theme you're using
159-
darkTheme: prismThemes.dracula, // optional -- pass in the Prism theme you're using
160-
},
161-
},
162-
},
163-
modalSettings: {
164-
// optional settings
165-
},
166-
searchSettings: {
167-
// optional settings
168-
},
169-
aiChatSettings: {
170-
// optional settings
171-
// botAvatarSrcUrl: "/img/logo.svg", // use your own bot avatar
172-
quickQuestions: [
173-
"How can I test my docs with Doc Detective?",
174-
"What does a test look like?",
175-
"What actions can Doc Detective perform?",
176-
],
177-
},
178-
},
179-
} satisfies Preset.ThemeConfig,
180-
plugins: [
181-
require.resolve("./src/plugins/webpack-browserify"),
182-
...(process.env.INKEEP_API_KEY
183-
? ["@inkeep/docusaurus/chatButton", "@inkeep/docusaurus/searchBar"]
184-
: []),
185-
...(process.env.POSTHOG_API_KEY
186-
? [
187-
[
188-
"posthog-docusaurus",
189-
{
190-
apiKey: process.env.POSTHOG_API_KEY,
191-
appUrl: "https://us.i.posthog.com",
192-
enableInDevelopment: false,
193-
},
194-
],
195-
]
196-
: []),
197-
],
198-
markdown: {
199-
mermaid: true,
200-
},
201-
themes: ["@docusaurus/theme-mermaid", "docusaurus-json-schema-plugin"],
65+
themeConfig: {
66+
// Replace with your project's social card
67+
image: "img/social-card.jpg",
68+
navbar: {
69+
title: "Doc Detective",
70+
logo: {
71+
alt: "Doc Detective Logo",
72+
src: "img/logo.svg",
73+
},
74+
items: [
75+
{
76+
type: "docSidebar",
77+
sidebarId: "docsSidebar",
78+
position: "left",
79+
label: "Get started",
80+
},
81+
{
82+
type: "docSidebar",
83+
sidebarId: "referencesSidebar",
84+
position: "left",
85+
label: "References",
86+
},
87+
// { to: "/app", label: "Action Builder (beta)", position: "left" },
88+
// {to: '/blog', label: 'Blog', position: 'left'},
89+
{ to: "/support", label: "Support ❤️", position: "right" },
90+
{
91+
type: "docSidebar",
92+
sidebarId: "contributeSidebar",
93+
position: "right",
94+
label: "Contribute",
95+
},
96+
{
97+
href: "https://github.com/doc-detective",
98+
label: "GitHub",
99+
position: "right",
100+
},
101+
],
102+
},
103+
footer: {
104+
style: "dark",
105+
links: [
106+
{
107+
title: "Docs",
108+
items: [
109+
{
110+
label: "Get started",
111+
to: "/docs/get-started/intro",
112+
},
113+
],
114+
},
115+
{
116+
title: "Community",
117+
items: [
118+
{
119+
label: "Discord",
120+
href: "https://discord.gg/2M7wXEThfF",
121+
},
122+
{
123+
label: "LinkedIn",
124+
href: "https://www.linkedin.com/company/doc-detective",
125+
},
126+
],
127+
},
128+
{
129+
title: "More",
130+
items: [
131+
// {
132+
// label: 'Blog',
133+
// to: '/blog',
134+
// },
135+
{
136+
label: "GitHub",
137+
href: "https://github.com/doc-detective",
138+
},
139+
],
140+
},
141+
],
142+
copyright: `Copyright © ${new Date().getFullYear()} Doc Detective.`,
143+
},
144+
prism: {
145+
theme: prismThemes.github,
146+
darkTheme: prismThemes.dracula,
147+
},
148+
inkeepConfig: {
149+
baseSettings: {
150+
apiKey: process.env.INKEEP_API_KEY, // required
151+
integrationId: process.env.INKEEP_INTEGRATION_ID, // required
152+
organizationId: process.env.INKEEP_ORGANIZATION_ID, // required
153+
primaryBrandColor: "#00c122", // required -- your brand color, the widget color scheme is derived from this
154+
organizationDisplayName: "Doc Detective", // required -- your organization name
155+
// ...optional settings
156+
theme: {
157+
// stylesheetUrls: ['/path/to/stylesheets'], // optional
158+
syntaxHighlighter: {
159+
lightTheme: prismThemes.github, // optional -- pass in the Prism theme you're using
160+
darkTheme: prismThemes.dracula, // optional -- pass in the Prism theme you're using
161+
},
162+
},
163+
},
164+
modalSettings: {
165+
// optional settings
166+
},
167+
searchSettings: {
168+
// optional settings
169+
},
170+
aiChatSettings: {
171+
// optional settings
172+
// botAvatarSrcUrl: "/img/logo.svg", // use your own bot avatar
173+
quickQuestions: [
174+
"How can I test my docs with Doc Detective?",
175+
"What does a test look like?",
176+
"What actions can Doc Detective perform?",
177+
],
178+
},
179+
},
180+
} satisfies Preset.ThemeConfig,
181+
plugins: [
182+
require.resolve("./src/plugins/webpack-browserify"),
183+
...(process.env.INKEEP_API_KEY
184+
? ["@inkeep/docusaurus/chatButton", "@inkeep/docusaurus/searchBar"]
185+
: []),
186+
...(process.env.POSTHOG_API_KEY
187+
? [
188+
[
189+
"posthog-docusaurus",
190+
{
191+
apiKey: process.env.POSTHOG_API_KEY,
192+
appUrl: "https://us.i.posthog.com",
193+
enableInDevelopment: false,
194+
},
195+
],
196+
]
197+
: []),
198+
],
199+
themes: ["@docusaurus/theme-mermaid", "docusaurus-json-schema-plugin"],
202200
};
203201

204202
export default config;

0 commit comments

Comments
 (0)