-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathdocusaurus.config.ts
More file actions
201 lines (186 loc) · 6.37 KB
/
docusaurus.config.ts
File metadata and controls
201 lines (186 loc) · 6.37 KB
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
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
import { themes as prismThemes } from 'prism-react-renderer';
import type { Config } from '@docusaurus/types';
import type * as Preset from '@docusaurus/preset-classic';
// This runs in Node.js - Don't use client-side code here (browser APIs, JSX...)
const config: Config = {
title: 'Bryce Seefieldt | Portfolio Documentation',
tagline: 'Dev docs and resources for the development portfolio project',
favicon: 'img/favicon2.png',
// Future flags, see https://docusaurus.io/docs/api/docusaurus-config#future
future: {
v4: true, // Improve compatibility with the upcoming Docusaurus v4
},
// Set the production url of your site here
url: process.env.DOCUSAURUS_SITE_URL || 'https://bryce.seefieldt.ca',
// Set the /<baseUrl>/ pathname under which your site is served
// Docs are served at /docs/ under the main portfolio domain.
// Override with DOCUSAURUS_BASE_URL env var (e.g. '/' for standalone preview).
baseUrl: process.env.DOCUSAURUS_BASE_URL || '/docs/',
// GitHub pages deployment config.
// If you aren't using GitHub pages, you don't need these.
organizationName: process.env.DOCUSAURUS_GITHUB_ORG || 'bryce-seefieldt', // Usually your GitHub org/user name.
projectName: process.env.DOCUSAURUS_GITHUB_REPO_DOCS || 'portfolio-docs', // Usually your repo name.
onBrokenLinks: 'throw',
onBrokenAnchors: 'warn',
// Custom fields for cross-repository linking
customFields: {
portfolioAppUrl:
process.env.DOCUSAURUS_PORTFOLIO_APP_URL || 'https://bryce.seefieldt.ca',
githubOrgUrl: `https://github.com/${process.env.DOCUSAURUS_GITHUB_ORG || 'bryce-seefieldt'}`,
githubRepoDocsUrl: `https://github.com/${process.env.DOCUSAURUS_GITHUB_ORG || 'bryce-seefieldt'}/${process.env.DOCUSAURUS_GITHUB_REPO_DOCS || 'portfolio-docs'}`,
githubRepoAppUrl: `https://github.com/${process.env.DOCUSAURUS_GITHUB_ORG || 'bryce-seefieldt'}/${process.env.DOCUSAURUS_GITHUB_REPO_APP || 'portfolio-app'}`,
},
// Even if you don't use internationalization, you can use this field to set
// useful metadata like html lang.
i18n: {
defaultLocale: 'en',
locales: ['en'],
},
themes: ['@docusaurus/theme-mermaid'],
markdown: {
mermaid: true,
},
// Custom webpack configuration to filter warnings
plugins: [
function webpackWarningPlugin() {
return {
name: 'webpack-warning-filter',
configureWebpack(_config, isServer) {
if (!isServer) {
return {};
}
return {
module: {
parser: {
javascript: {
exprContextCritical: false,
},
},
},
ignoreWarnings: [
// Suppress vscode-languageserver-types warning from mermaid → langium chain
{
module:
/vscode-languageserver-types[\\/]lib[\\/]umd[\\/]main\.js$/,
message:
/Critical dependency: require function is used in a way in which dependencies cannot be statically extracted/,
},
],
};
},
};
},
],
presets: [
[
'classic',
{
docs: {
sidebarPath: './sidebars.ts',
// Serve docs at baseUrl root (e.g. /docs/<doc-path> with baseUrl=/docs/).
// This avoids the double-path /docs/docs/... that would result from the
// default routeBasePath of 'docs' combined with baseUrl '/docs/'.
routeBasePath: '/',
// Please change this to your repo.
// Remove this to remove the "edit this page" links.
// editUrl:
// 'https://github.com/bryce-seefieldt/portfolio-docs/tree/main/',
},
blog: {
showReadingTime: true,
feedOptions: {
type: ['rss', 'atom'],
xslt: true,
},
// Please change this to your repo.
// Remove this to remove the "edit this page" links.
editUrl: `https://github.com/${process.env.DOCUSAURUS_GITHUB_ORG || 'bryce-seefieldt'}/${process.env.DOCUSAURUS_GITHUB_REPO_DOCS || 'portfolio-docs'}/tree/main/`,
// Useful options to enforce blogging best practices
onInlineTags: 'warn',
onInlineAuthors: 'warn',
onUntruncatedBlogPosts: 'warn',
},
theme: {
customCss: './src/css/custom.css',
},
} satisfies Preset.Options,
],
],
themeConfig: {
mermaid: {
theme: { light: 'default', dark: 'dark' },
},
// Replace with your project's social card
image: 'img/docusaurus-social-card.jpg',
colorMode: {
respectPrefersColorScheme: true,
},
navbar: {
title: 'Portfolio Documentation',
logo: {
alt: 'Bryce Seefieldt Logo',
src: 'img/seven30.png',
},
items: [
{
type: 'docSidebar',
sidebarId: 'docsSidebar',
position: 'left',
label: 'Docs',
},
// {to: '/blog', label: 'Blog', position: 'left'},
{
href: `https://github.com/${process.env.DOCUSAURUS_GITHUB_ORG || 'bryce-seefieldt'}/${process.env.DOCUSAURUS_GITHUB_REPO_DOCS || 'portfolio-docs'}`,
label: 'GitHub',
position: 'right',
},
],
},
footer: {
style: 'dark',
links: [
{
title: 'Docs',
items: [
{
label: 'Portfolio Documentation',
to: '/',
},
],
},
{
title: 'Community',
items: [
{
label: 'Stack Overflow',
href: 'https://stackoverflow.com/questions/tagged/docusaurus',
},
{
label: 'Discord',
href: 'https://discordapp.com/invite/docusaurus',
},
],
},
{
title: 'More',
items: [
// {
// label: 'Blog',
// to: '/blog',
// },
{
label: 'GitHub',
href: `https://github.com/${process.env.DOCUSAURUS_GITHUB_ORG || 'bryce-seefieldt'}/`,
},
],
},
],
copyright: `Copyright © ${new Date().getFullYear()} Bryce Seefieldt. Built with Docusaurus.`,
},
prism: {
theme: prismThemes.github,
darkTheme: prismThemes.dracula,
},
} satisfies Preset.ThemeConfig,
};
export default config;