-
-
Notifications
You must be signed in to change notification settings - Fork 115
/
docusaurus.config.js
148 lines (137 loc) · 4.37 KB
/
docusaurus.config.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
// @ts-check
// `@type` JSDoc annotations allow editor autocompletion and type checking
// (when paired with `@ts-check`).
// There are various equivalent ways to declare your Docusaurus config.
// See: https://docusaurus.io/docs/api/docusaurus-config
import {themes as prismThemes} from 'prism-react-renderer';
/** @type {import('@docusaurus/types').Config} */
const config = {
title: 'Open Source Education with OpenSauced',
tagline: 'Empowering Your Open Source Journey: From First Contribution to Project Leadership',
favicon: 'img/favicon.ico',
// Set the production url of your site here
url: 'https://opensauced.pizza',
// Set the /<baseUrl>/ pathname under which your site is served
// For GitHub pages deployment, it is often '/<projectName>/'
baseUrl: '/learn/',
// GitHub pages deployment config.
// If you aren't using GitHub pages, you don't need these.
organizationName: 'OpenSauced', // Usually your GitHub org/user name.
projectName: 'open source learning path', // Usually your repo name.
onBrokenLinks: 'throw',
onBrokenMarkdownLinks: 'warn',
// Even if you don't use internationalization, 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: './sidebars.js',
// Dynamic editUrl construction
editUrl: ({ versionDocsDirPath, docPath }) =>
`https://github.com/open-sauced/intro/edit/main/${versionDocsDirPath}/${docPath}`,
routeBasePath: '/',
},
theme: {
customCss: './src/css/custom.css',
},
}),
],
],
themeConfig:
/** @type {import('@docusaurus/preset-classic').ThemeConfig} */
({
// Replace with your project's social card
image: 'img/docusaurus-social-card.jpg',
navbar: {
title: 'Open Source Education Path',
logo: {
alt: 'My Site Logo',
src: '/img/favicon.ico',
},
items: [
{
type: 'docSidebar',
sidebarId: 'introToOSS',
position: 'left',
label: 'Intro to Open Source',
},
{
type: 'docSidebar',
sidebarId: 'becomingAMaintainer',
position: 'left',
label: 'Becoming a Maintainer',
},
{href: 'https://opensauced.pizza/docs/community-resources', label: 'Blog', position: 'left'},
{
href: 'https://github.com/open-sauced/intro',
label: 'GitHub',
position: 'right',
},
],
},
footer: {
logo: {
alt: "OpenSauced Logo",
src: "img/logo_lightmode.png",
href: "https://opensauced.pizza/",
height: 40,
},
style: "light",
links: [
{
title: "Learn",
items: [
{
label: "Contributing guide",
to: "https://github.com/open-sauced/intro/blob/main/contributing/CONTRIBUTING.md",
},
{
label: "Open Source Courses",
to: "https://intro.opensauced.pizza/#/",
},
],
},
{
title: "Community",
items: [
{
label: "GitHub",
href: "https://github.com/orgs/open-sauced/discussions",
},
{
label: "X",
href: "https://x.com/saucedopen",
},
],
},
{
title: "More",
items: [
{
label: "Blog",
href: "https://opensauced.pizza/docs/community-resources",
},
{
label: "Watch our feature demos",
href: "https://www.youtube.com/playlist?list=PLHyZ0Wz_A44VRlE-YS9me5qxDNRgK5T3H"
}
],
},
],
copyright: `Copyright © ${new Date().getFullYear()} My Project, Inc. Built with Docusaurus.`,
},
prism: {
theme: prismThemes.github,
darkTheme: prismThemes.dracula,
},
}),
};
export default config;