WARNING: THIS SITE IS A MIRROR OF GITHUB.COM / IT CANNOT LOGIN OR REGISTER ACCOUNTS / THE CONTENTS ARE PROVIDED AS-IS / THIS SITE ASSUMES NO RESPONSIBILITY FOR ANY DISPLAYED CONTENT OR LINKS / IF YOU FOUND SOMETHING MAY NOT GOOD FOR EVERYONE, CONTACT ADMIN AT ilovescratch@foxmail.com
Skip to content

Commit e2866cc

Browse files
committed
Fixed the docusausus config
1 parent 2c68269 commit e2866cc

File tree

1 file changed

+99
-13
lines changed

1 file changed

+99
-13
lines changed

docusaurus.config.ts

Lines changed: 99 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2,32 +2,82 @@ import {themes as prismThemes} from 'prism-react-renderer';
22
import type {Config} from '@docusaurus/types';
33
import type * as Preset from '@docusaurus/preset-classic';
44

5+
// This runs in Node.js - Don't use client-side code here (browser APIs, JSX...)
6+
57
const config: Config = {
6-
title: 'SMOCS Documentation',
7-
tagline: 'Streaming Monitoring Optimization Control System',
8+
title: 'SMOCS Documentation',
9+
tagline: 'Streaming Monitoring Optimization Control System',
810
favicon: 'img/favicon.ico',
911

12+
// Future flags, see https://docusaurus.io/docs/api/docusaurus-config#future
13+
future: {
14+
v4: true, // Improve compatibility with the upcoming Docusaurus v4
15+
},
16+
17+
// Set the production url of your site here
1018
url: 'https://armenkasp.github.io',
19+
// Set the /<baseUrl>/ pathname under which your site is served
20+
// For GitHub pages deployment, it is often '/<projectName>/'
1121
baseUrl: '/SMOCS-DOCS/',
12-
13-
// Update these
14-
organizationName: 'armenkasp',
15-
projectName: 'SMOCS-DOCS',
1622

17-
// Navigation bar
23+
// GitHub pages deployment config.
24+
// If you aren't using GitHub pages, you don't need these.
25+
organizationName: 'armenkasp', // Usually your GitHub org/user name.
26+
projectName: 'SMOCS-DOCS', // Usually your repo name.
27+
28+
onBrokenLinks: 'throw',
29+
onBrokenMarkdownLinks: 'warn',
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+
},
38+
39+
presets: [
40+
[
41+
'classic',
42+
{
43+
docs: {
44+
sidebarPath: './sidebars.ts',
45+
editUrl:
46+
'https://github.com/JeffersonLab/SMOCS',
47+
},
48+
blog: {
49+
showReadingTime: true,
50+
feedOptions: {
51+
type: ['rss', 'atom'],
52+
xslt: true,
53+
},
54+
editUrl:
55+
'https://github.com/JeffersonLab/SMOCS',
56+
onInlineTags: 'warn',
57+
onInlineAuthors: 'warn',
58+
onUntruncatedBlogPosts: 'warn',
59+
},
60+
theme: {
61+
customCss: './src/css/custom.css',
62+
},
63+
} satisfies Preset.Options,
64+
],
65+
],
66+
1867
themeConfig: {
68+
image: 'img/docusaurus-social-card.jpg',
1969
navbar: {
2070
title: 'SMOCS Docs',
2171
logo: {
2272
alt: 'SMOCS Logo',
23-
src: 'img/logo.svg',
73+
src: 'img/logo.svg',
2474
},
2575
items: [
2676
{
2777
type: 'docSidebar',
2878
sidebarId: 'tutorialSidebar',
2979
position: 'left',
30-
label: 'Documentation',
80+
label: 'Documentation',
3181
},
3282
{to: '/blog', label: 'Blog', position: 'left'},
3383
{
@@ -40,9 +90,45 @@ const config: Config = {
4090
footer: {
4191
style: 'dark',
4292
links: [
43-
'https://github.com/JeffersonLab/SMOCS'
93+
{
94+
title: 'Docs',
95+
items: [
96+
{
97+
label: 'Documentation',
98+
to: '/docs/intro',
99+
},
100+
],
101+
},
102+
{
103+
title: 'Community',
104+
items: [
105+
{
106+
label: 'GitHub Issues',
107+
href: 'https://github.com/JeffersonLab/SMOCS/issues',
108+
},
109+
],
110+
},
111+
{
112+
title: 'More',
113+
items: [
114+
{
115+
label: 'Blog',
116+
to: '/blog',
117+
},
118+
{
119+
label: 'GitHub',
120+
href: 'https://github.com/JeffersonLab/SMOCS',
121+
},
122+
],
123+
},
44124
],
45-
copyright: `Copyright © ${new Date().getFullYear()} SMOCS Project.`,
125+
copyright: `Copyright © ${new Date().getFullYear()} SMOCS Documentaiton. Built with Docusaurus.`,
46126
},
47-
},
48-
};
127+
prism: {
128+
theme: prismThemes.github,
129+
darkTheme: prismThemes.dracula,
130+
},
131+
} satisfies Preset.ThemeConfig,
132+
};
133+
134+
export default config;

0 commit comments

Comments
 (0)