-
Notifications
You must be signed in to change notification settings - Fork 1
/
docusaurus.config.ts
176 lines (164 loc) · 4.77 KB
/
docusaurus.config.ts
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
import { themes as prismThemes } from "prism-react-renderer";
import type { Config } from "@docusaurus/types";
import type * as Preset from "@docusaurus/preset-classic";
const config: Config = {
title: "Geoconnex Documentation",
tagline: "Data infrastructure for unifying hydrologic features in the United States",
favicon: "img/favicon.ico",
// Set the production url of your site here
url: "https://docs.geoconnex.us",
// Set the /<baseUrl>/ pathname under which your site is served
// For GitHub pages deployment, it is often '/<projectName>/'
baseUrl: "/",
// GitHub pages deployment config.
// If you aren't using GitHub pages, you don't need these.
organizationName: "internetofwater", // Usually your GitHub org/user name.
projectName: "docs.geoconnex.us", // Usually your repo name.
onBrokenLinks: "throw",
onBrokenMarkdownLinks: "throw",
// 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",
{
docs: {
routeBasePath: "/", // Serve the docs at the site's root
sidebarPath: "./sidebars.ts",
// Remove this to remove the "edit this page" links.
editUrl: "https://github.com/internetofwater/docs.geoconnex.us/edit/main/",
},
theme: {
customCss: "./src/css/custom.css",
},
blog: false,
} satisfies Preset.Options,
],
],
themes: [
[
// https://github.com/easyops-cn/docusaurus-search-local
require.resolve("@easyops-cn/docusaurus-search-local"),
/** @type {import("@easyops-cn/docusaurus-search-local").PluginOptions} */
{
// ... Your options.
// `hashed` is recommended as long-term-cache of index file is possible.
hashed: true,
docsRouteBasePath: "/",
indexDocs: true,
removeDefaultStemmer: true,
},
],
],
themeConfig: {
// Replace with your project's social card
image: "geoconnex-logo.png",
docs: {
sidebar: {
hideable: true,
},
},
// announcementBar: {
// content: "",
// isCloseable: tr0ue,
// },
navbar: {
logo: {
alt: "Geoconnex Logo",
src: "outlined-logo-no-words.png",
},
hideOnScroll: true,
items: [
{
type: "docSidebar",
sidebarId: "AboutSidebar",
position: "left",
label: "About",
},
{
type: "docSidebar",
sidebarId: "ContributingSidebar",
position: "left",
label: "Contribute",
},
{
type: "docSidebar",
sidebarId: "QueryingSidebar",
position: "left",
label: "Access Data",
},
{
type: "docSidebar",
sidebarId: "DataFormatReferenceSidebar",
position: "left",
label: "Best Practices & Data Standards",
},
{
type: "docSidebar",
sidebarId: "SystemArchitectureSidebar",
position: "left",
label: "System Architecture",
},
{
type: "docSidebar",
sidebarId: "PlaygroundSidebar",
position: "left",
label: "Playgrounds",
},
{
href: "https://github.com/internetofwater/docs.geoconnex.us",
label: "GitHub",
position: "right",
},
],
},
footer: {
style: "dark",
links: [
// {
// title: "Docs",
// items: [
// {
// label: "Docs",
// to: "/docs/",
// },
// ],
// },
{
title: "Geoconnex Links",
items: [
{
label: "Official Website",
href: "https://geoconnex.us",
},
],
},
{
title: "More",
items: [
{
label: "GitHub",
href: "https://github.com/internetofwater/",
},
],
},
],
copyright: `Licensed under the CC0 Creative Commons Zero 1.0 (CC0) license and based upon work supported by the U.S. Geological Survey under Grant Nos. G21AP10607 and G21AC10732 `,
},
prism: {
theme: prismThemes.github,
darkTheme: prismThemes.dracula,
// markup-templating is the dependency for django and turtle is a dependency for sparql
additionalLanguages: ["json", "yaml", "markup-templating", "django", "turtle", "sparql", "bash", "r"],
},
colorMode: {
respectPrefersColorScheme: true,
},
} satisfies Preset.ThemeConfig,
};
export default config;