Skip to content

Commit e84d49a

Browse files
committed
reduce duplication, centralize constants, and fix some more variables
1 parent 488d849 commit e84d49a

File tree

1 file changed

+29
-34
lines changed

1 file changed

+29
-34
lines changed

docusaurus.config.ts

Lines changed: 29 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,31 @@ import type * as Preset from '@docusaurus/preset-classic';
44

55
const GH_ORGANIZATION_NAME: string = "CollinRoboticsClub";
66
const GH_REPOSITORY_NAME: string = "documentation";
7+
const GH_URL: string = `https://github.com/${GH_ORGANIZATION_NAME}/${GH_REPOSITORY_NAME}`
78

89
const TITLE: string = "Collin College Robotics Club Documentation";
10+
const TAGLINE: string = ""
911

1012
const GH_PAGES_URL: string = `https://${GH_ORGANIZATION_NAME.toLowerCase()}.github.io`;
1113

14+
const paths = {
15+
ts: {
16+
SIDEBAR: './sidebars.ts',
17+
},
18+
images: {
19+
FAVICON: 'img/favicon.ico',
20+
21+
// FIXME:
22+
SOCIAL_CARD: 'img/docusaurus-social-card.jpg',
23+
SITE_LOGO: 'img/logo.svg',
24+
},
25+
CUSTOM_CSS: './src/css/custom.css',
26+
}
27+
1228
const config: Config = {
1329
title: TITLE,
14-
tagline: 'Dinosaurs are cool',
15-
favicon: 'img/favicon.ico',
30+
tagline: TAGLINE,
31+
favicon: paths.images.FAVICON,
1632

1733
// Set the production url of your site here
1834
url: GH_PAGES_URL,
@@ -41,42 +57,24 @@ const config: Config = {
4157
'classic',
4258
{
4359
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.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/',
49-
},
50-
blog: {
51-
showReadingTime: true,
52-
feedOptions: {
53-
type: ['rss', 'atom'],
54-
xslt: true,
55-
},
56-
// Please change this to your repo.
57-
// Remove this to remove the "edit this page" links.
58-
editUrl:
59-
'https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/',
60-
// Useful options to enforce blogging best practices
61-
onInlineTags: 'warn',
62-
onInlineAuthors: 'warn',
63-
onUntruncatedBlogPosts: 'warn',
60+
sidebarPath: paths.ts.SIDEBAR,
61+
// TESTME: Remove this to remove the "edit this page" links.
62+
editUrl: (GH_URL + '/tree/main/packages/create-docusaurus/templates/shared/'),
6463
},
6564
theme: {
66-
customCss: './src/css/custom.css',
65+
customCss: paths.CUSTOM_CSS,
6766
},
6867
} satisfies Preset.Options,
6968
],
7069
],
7170

7271
themeConfig: {
73-
// Replace with your project's social card
74-
image: 'img/docusaurus-social-card.jpg',
72+
image: paths.images.SOCIAL_CARD,
7573
navbar: {
76-
title: 'My Site',
74+
title: TITLE,
7775
logo: {
7876
alt: 'My Site Logo',
79-
src: 'img/logo.svg',
77+
src: paths.images.SITE_LOGO,
8078
},
8179
items: [
8280
{
@@ -85,9 +83,8 @@ const config: Config = {
8583
position: 'left',
8684
label: 'Tutorial',
8785
},
88-
{to: '/blog', label: 'Blog', position: 'left'},
8986
{
90-
href: 'https://github.com/facebook/docusaurus',
87+
href: GH_URL,
9188
label: 'GitHub',
9289
position: 'right',
9390
},
@@ -106,6 +103,7 @@ const config: Config = {
106103
],
107104
},
108105
{
106+
// FIXME:
109107
title: 'Community',
110108
items: [
111109
{
@@ -125,17 +123,14 @@ const config: Config = {
125123
{
126124
title: 'More',
127125
items: [
128-
{
129-
label: 'Blog',
130-
to: '/blog',
131-
},
132126
{
133127
label: 'GitHub',
134-
href: 'https://github.com/facebook/docusaurus',
128+
href: GH_URL,
135129
},
136130
],
137131
},
138132
],
133+
// FIXME:
139134
copyright: `Copyright © ${new Date().getFullYear()} My Project, Inc. Built with Docusaurus.`,
140135
},
141136
prism: {

0 commit comments

Comments
 (0)