Spaces:
Build error
Build error
Create docusaurus.config.js
Browse files- docusaurus.config.js +149 -0
docusaurus.config.js
ADDED
@@ -0,0 +1,149 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
// @ts-check
|
2 |
+
// `@type` JSDoc annotations allow editor autocompletion and type checking
|
3 |
+
// (when paired with `@ts-check`).
|
4 |
+
// There are various equivalent ways to declare your Docusaurus config.
|
5 |
+
// See: https://docusaurus.io/docs/api/docusaurus-config
|
6 |
+
|
7 |
+
import {themes as prismThemes} from 'prism-react-renderer';
|
8 |
+
|
9 |
+
/** @type {import('@docusaurus/types').Config} */
|
10 |
+
const config = {
|
11 |
+
title: 'My Site',
|
12 |
+
tagline: 'Dinosaurs are cool',
|
13 |
+
favicon: 'img/favicon.ico',
|
14 |
+
|
15 |
+
// Set the production url of your site here
|
16 |
+
url: 'https://your-docusaurus-site.example.com',
|
17 |
+
// Set the /<baseUrl>/ pathname under which your site is served
|
18 |
+
// For GitHub pages deployment, it is often '/<projectName>/'
|
19 |
+
baseUrl: '/',
|
20 |
+
|
21 |
+
// GitHub pages deployment config.
|
22 |
+
// If you aren't using GitHub pages, you don't need these.
|
23 |
+
organizationName: 'facebook', // Usually your GitHub org/user name.
|
24 |
+
projectName: 'docusaurus', // Usually your repo name.
|
25 |
+
|
26 |
+
onBrokenLinks: 'throw',
|
27 |
+
onBrokenMarkdownLinks: 'warn',
|
28 |
+
|
29 |
+
// Even if you don't use internationalization, you can use this field to set
|
30 |
+
// useful metadata like html lang. For example, if your site is Chinese, you
|
31 |
+
// may want to replace "en" with "zh-Hans".
|
32 |
+
i18n: {
|
33 |
+
defaultLocale: 'en',
|
34 |
+
locales: ['en'],
|
35 |
+
},
|
36 |
+
|
37 |
+
presets: [
|
38 |
+
[
|
39 |
+
'classic',
|
40 |
+
/** @type {import('@docusaurus/preset-classic').Options} */
|
41 |
+
({
|
42 |
+
docs: {
|
43 |
+
sidebarPath: './sidebars.js',
|
44 |
+
// Please change this to your repo.
|
45 |
+
// Remove this to remove the "edit this page" links.
|
46 |
+
editUrl:
|
47 |
+
'https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/',
|
48 |
+
},
|
49 |
+
blog: {
|
50 |
+
showReadingTime: true,
|
51 |
+
feedOptions: {
|
52 |
+
type: ['rss', 'atom'],
|
53 |
+
xslt: true,
|
54 |
+
},
|
55 |
+
// Please change this to your repo.
|
56 |
+
// Remove this to remove the "edit this page" links.
|
57 |
+
editUrl:
|
58 |
+
'https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/',
|
59 |
+
// Useful options to enforce blogging best practices
|
60 |
+
onInlineTags: 'warn',
|
61 |
+
onInlineAuthors: 'warn',
|
62 |
+
onUntruncatedBlogPosts: 'warn',
|
63 |
+
},
|
64 |
+
theme: {
|
65 |
+
customCss: './src/css/custom.css',
|
66 |
+
},
|
67 |
+
}),
|
68 |
+
],
|
69 |
+
],
|
70 |
+
|
71 |
+
themeConfig:
|
72 |
+
/** @type {import('@docusaurus/preset-classic').ThemeConfig} */
|
73 |
+
({
|
74 |
+
// Replace with your project's social card
|
75 |
+
image: 'img/docusaurus-social-card.jpg',
|
76 |
+
navbar: {
|
77 |
+
title: 'My Site',
|
78 |
+
logo: {
|
79 |
+
alt: 'My Site Logo',
|
80 |
+
src: 'img/logo.svg',
|
81 |
+
},
|
82 |
+
items: [
|
83 |
+
{
|
84 |
+
type: 'docSidebar',
|
85 |
+
sidebarId: 'tutorialSidebar',
|
86 |
+
position: 'left',
|
87 |
+
label: 'Tutorial',
|
88 |
+
},
|
89 |
+
{to: '/blog', label: 'Blog', position: 'left'},
|
90 |
+
{
|
91 |
+
href: 'https://github.com/facebook/docusaurus',
|
92 |
+
label: 'GitHub',
|
93 |
+
position: 'right',
|
94 |
+
},
|
95 |
+
],
|
96 |
+
},
|
97 |
+
footer: {
|
98 |
+
style: 'dark',
|
99 |
+
links: [
|
100 |
+
{
|
101 |
+
title: 'Docs',
|
102 |
+
items: [
|
103 |
+
{
|
104 |
+
label: 'Tutorial',
|
105 |
+
to: '/docs/intro',
|
106 |
+
},
|
107 |
+
],
|
108 |
+
},
|
109 |
+
{
|
110 |
+
title: 'Community',
|
111 |
+
items: [
|
112 |
+
{
|
113 |
+
label: 'Stack Overflow',
|
114 |
+
href: 'https://stackoverflow.com/questions/tagged/docusaurus',
|
115 |
+
},
|
116 |
+
{
|
117 |
+
label: 'Discord',
|
118 |
+
href: 'https://discordapp.com/invite/docusaurus',
|
119 |
+
},
|
120 |
+
{
|
121 |
+
label: 'Twitter',
|
122 |
+
href: 'https://twitter.com/docusaurus',
|
123 |
+
},
|
124 |
+
],
|
125 |
+
},
|
126 |
+
{
|
127 |
+
title: 'More',
|
128 |
+
items: [
|
129 |
+
{
|
130 |
+
label: 'Blog',
|
131 |
+
to: '/blog',
|
132 |
+
},
|
133 |
+
{
|
134 |
+
label: 'GitHub',
|
135 |
+
href: 'https://github.com/facebook/docusaurus',
|
136 |
+
},
|
137 |
+
],
|
138 |
+
},
|
139 |
+
],
|
140 |
+
copyright: `Copyright © ${new Date().getFullYear()} My Project, Inc. Built with Docusaurus.`,
|
141 |
+
},
|
142 |
+
prism: {
|
143 |
+
theme: prismThemes.github,
|
144 |
+
darkTheme: prismThemes.dracula,
|
145 |
+
},
|
146 |
+
}),
|
147 |
+
};
|
148 |
+
|
149 |
+
export default config;
|