Skip to content

Commit 4db57ee

Browse files
committed
config file cleanup
1 parent 2369139 commit 4db57ee

File tree

1 file changed

+154
-148
lines changed

1 file changed

+154
-148
lines changed

docusaurus.config.ts

+154-148
Original file line numberDiff line numberDiff line change
@@ -3,172 +3,178 @@ import type { Config } from "@docusaurus/types";
33
import { themes as prismThemes } from "prism-react-renderer";
44
import { EnumChangefreq } from "sitemap";
55

6-
// const baseUrl = "/docs";
76
const baseUrl = "/";
8-
// const baseUrl = "https://docs.coderabbit.ai/";
97

108
const config: Config = {
11-
title: "CodeRabbit",
12-
staticDirectories: ["public", "static"],
13-
tagline: "AI-powered Code Reviews",
14-
favicon: "img/favIcon.png",
9+
title: "CodeRabbit",
10+
staticDirectories: ["public", "static"],
11+
tagline: "AI-powered Code Reviews",
12+
favicon: "img/favIcon.png",
1513

16-
// Set the production url of your site here
17-
url: "https://coderabbit.ai/",
18-
// Set the /<baseUrl>/ pathname under which your site is served
19-
// For GitHub pages deployment, it is often '/<projectName>/'
20-
baseUrl: baseUrl,
14+
// Set the production url of your site here
15+
url: "https://coderabbit.ai/",
16+
// Set the /<baseUrl>/ pathname under which your site is served
17+
// For GitHub pages deployment, it is often '/<projectName>/'
18+
baseUrl: baseUrl,
2119

22-
// GitHub pages deployment config.
23-
// If you aren't using GitHub pages, you don't need these.
24-
organizationName: "facebook", // Usually your GitHub org/user name.
25-
projectName: "docusaurus", // Usually your repo name.
20+
// GitHub pages deployment config.
21+
// If you aren't using GitHub pages, you don't need these.
22+
organizationName: "facebook", // Usually your GitHub org/user name.
23+
projectName: "docusaurus", // Usually your repo name.
2624

27-
onBrokenLinks: "throw",
28-
onBrokenMarkdownLinks: "warn",
25+
onBrokenLinks: "throw",
26+
onBrokenMarkdownLinks: "warn",
2927

30-
// Even if you don't use internationalization, you can use this field to set
31-
// useful metadata like html lang. For example, if your site is Chinese, you
32-
// may want to replace "en" with "zh-Hans".
33-
i18n: {
34-
defaultLocale: "en",
35-
locales: ["en"],
36-
},
28+
// Even if you don't use internationalization, you can use this field to set
29+
// useful metadata like html lang. For example, if your site is Chinese, you
30+
// may want to replace "en" with "zh-Hans".
31+
i18n: {
32+
defaultLocale: "en",
33+
locales: ["en"],
34+
},
3735

38-
plugins: [
39-
[
40-
"@docusaurus/plugin-client-redirects",
41-
{
42-
redirects: [
43-
{
44-
to: "https://docs.coderabbit.ai/docs/get-started/signup",
45-
from: "/docs/get-started",
46-
},
47-
],
48-
},
49-
],
50-
async function myPlugin(context, options) {
51-
return {
52-
name: "docusaurus-tailwindcss",
53-
configurePostCss(postcssOptions) {
54-
// Appends TailwindCSS and AutoPrefixer.
55-
postcssOptions.plugins.push(require("tailwindcss"));
56-
postcssOptions.plugins.push(require("autoprefixer"));
57-
return postcssOptions;
58-
},
59-
};
60-
},
61-
],
62-
63-
presets: [
64-
[
65-
"classic",
66-
{
67-
docs: {
68-
sidebarPath: "./sidebars.ts",
69-
routeBasePath: "/",
70-
breadcrumbs: true,
71-
showLastUpdateTime: true,
72-
},
73-
blog: {
74-
routeBasePath: "/blog",
75-
showReadingTime: true,
76-
},
77-
theme: {
78-
customCss: "./src/css/custom.css",
79-
},
80-
sitemap: {
81-
changefreq: "weekly" as EnumChangefreq,
82-
priority: 0.5,
83-
ignorePatterns: ["/tags/**"],
84-
filename: "sitemap.xml",
85-
},
86-
googleTagManager: {
87-
containerId: "GTM-5BWLXJRC",
88-
},
89-
} satisfies Preset.Options,
36+
plugins: [
37+
[
38+
"@docusaurus/plugin-client-redirects",
39+
{
40+
redirects: [
41+
{
42+
to: "https://docs.coderabbit.ai/docs/get-started/signup",
43+
from: "/docs/get-started",
44+
},
9045
],
46+
},
9147
],
48+
async function myPlugin(context, options) {
49+
return {
50+
name: "docusaurus-tailwindcss",
51+
configurePostCss(postcssOptions) {
52+
// Appends TailwindCSS and AutoPrefixer.
53+
postcssOptions.plugins.push(require("tailwindcss"));
54+
postcssOptions.plugins.push(require("autoprefixer"));
55+
return postcssOptions;
56+
},
57+
};
58+
},
59+
],
9260

93-
scripts: [
94-
"https://buttons.github.io/buttons.js",
95-
"https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js",
96-
"/docs/js/code-block-buttons.js",
97-
`https://cdnjs.cloudflare.com/ajax/libs/axios/1.2.1/axios.min.js`,
98-
{
99-
src: "https://cdnjs.cloudflare.com/ajax/libs/axios/1.2.1/axios.min.js",
100-
async: true,
61+
presets: [
62+
[
63+
"classic",
64+
{
65+
docs: {
66+
sidebarPath: "./sidebars.ts",
67+
routeBasePath: "/",
68+
breadcrumbs: true,
69+
showLastUpdateTime: true,
70+
},
71+
blog: {
72+
blogTitle: "CodeRabbit Blog",
73+
blogDescription: "Blog",
74+
tagsBasePath: "/tags",
75+
editLocalizedFiles: false,
76+
routeBasePath: "/blog",
77+
showReadingTime: true,
78+
blogSidebarCount: "ALL",
79+
blogSidebarTitle: "All our posts",
80+
blogListComponent: "@theme/BlogListPage",
81+
blogPostComponent: "@theme/BlogPostPage",
82+
},
83+
theme: {
84+
customCss: "./src/css/custom.css",
10185
},
86+
sitemap: {
87+
changefreq: "weekly" as EnumChangefreq,
88+
priority: 0.5,
89+
ignorePatterns: ["/tags/**"],
90+
filename: "sitemap.xml",
91+
},
92+
googleTagManager: {
93+
containerId: "GTM-5BWLXJRC",
94+
},
95+
} satisfies Preset.Options,
10296
],
97+
],
10398

104-
themeConfig: {
105-
// Replace with your project's social card
106-
editUrl: null,
107-
colorMode: {
108-
defaultMode: "light",
109-
disableSwitch: false,
110-
respectPrefersColorScheme: false,
99+
scripts: [
100+
"https://buttons.github.io/buttons.js",
101+
"https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js",
102+
"/docs/js/code-block-buttons.js",
103+
`https://cdnjs.cloudflare.com/ajax/libs/axios/1.2.1/axios.min.js`,
104+
{
105+
src: "https://cdnjs.cloudflare.com/ajax/libs/axios/1.2.1/axios.min.js",
106+
async: true,
107+
},
108+
],
109+
110+
themeConfig: {
111+
// Replace with your project's social card
112+
editUrl: null,
113+
colorMode: {
114+
defaultMode: "light",
115+
disableSwitch: false,
116+
respectPrefersColorScheme: false,
117+
},
118+
docs: {
119+
sidebar: {
120+
hideable: true,
121+
},
122+
},
123+
metadata: [
124+
{ name: "keywords", content: "ai, blog" },
125+
{ name: "twitter:card", content: "summary_large_image" },
126+
],
127+
headTags: [
128+
// Declare a <link> preconnect tag
129+
{
130+
tagName: "link",
131+
attributes: {
132+
rel: "preconnect",
133+
href: "https://coderabbit.ai/blog/coderabbit-deep-dive",
111134
},
112-
docs: {
113-
sidebar: {
114-
hideable: true,
115-
},
135+
},
136+
// Declare some json-ld structured data
137+
],
138+
image: "img/docusaurus-social-card.jpg",
139+
navbar: {
140+
title: "",
141+
hideOnScroll: true,
142+
logo: {
143+
alt: "",
144+
src: "img/coderabbit_nav_logo.svg",
145+
href: "https://coderabbit.ai",
146+
},
147+
items: [
148+
{
149+
type: "docSidebar",
150+
docId: "docs",
151+
sidebarId: "docsSidebar",
152+
position: "left",
153+
label: "Docs",
154+
href: "https://docs.coderabbit.ai",
155+
target: "_self",
116156
},
117-
metadata: [
118-
{ name: "keywords", content: "ai, blog" },
119-
{ name: "twitter:card", content: "summary_large_image" },
120-
],
121-
headTags: [
122-
// Declare a <link> preconnect tag
123-
{
124-
tagName: "link",
125-
attributes: {
126-
rel: "preconnect",
127-
href: "https://coderabbit.ai/blog/coderabbit-deep-dive",
128-
},
129-
},
130-
// Declare some json-ld structured data
131-
],
132-
image: "img/docusaurus-social-card.jpg",
133-
navbar: {
134-
title: "",
135-
hideOnScroll: true,
136-
logo: {
137-
alt: "",
138-
src: "img/coderabbit_nav_logo.svg",
139-
href: "https://coderabbit.ai",
140-
},
141-
items: [
142-
{
143-
type: "docSidebar",
144-
docId: "docs",
145-
sidebarId: "docsSidebar",
146-
position: "left",
147-
label: "Docs",
148-
href: "https://docs.coderabbit.ai",
149-
target: "_self",
150-
},
151-
{
152-
// type: "docSidebar",
153-
// sidebarId: "blogsSidebar",
154-
position: "left",
155-
label: "Blog",
156-
href: "https://blog.coderabbit.ai/blog",
157-
},
158-
{
159-
href: "https://discord.gg/GsXnASn26c",
160-
className: "header-discord-link",
161-
"aria-label": "Discord",
162-
position: "right",
163-
label: "Discord",
164-
},
165-
],
157+
{
158+
// type: "docSidebar",
159+
// sidebarId: "blogsSidebar",
160+
position: "left",
161+
label: "Blog",
162+
href: "https://blog.coderabbit.ai/blog",
166163
},
167-
prism: {
168-
theme: prismThemes.github,
169-
darkTheme: prismThemes.dracula,
164+
{
165+
href: "https://discord.gg/GsXnASn26c",
166+
className: "header-discord-link",
167+
"aria-label": "Discord",
168+
position: "right",
169+
label: "Discord",
170170
},
171-
} satisfies Preset.ThemeConfig,
171+
],
172+
},
173+
prism: {
174+
theme: prismThemes.github,
175+
darkTheme: prismThemes.dracula,
176+
},
177+
} satisfies Preset.ThemeConfig,
172178
};
173179

174180
export default config;

0 commit comments

Comments
 (0)