-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathdocusaurus.config.js
More file actions
160 lines (153 loc) · 6.34 KB
/
Copy pathdocusaurus.config.js
File metadata and controls
160 lines (153 loc) · 6.34 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
// @ts-check
import {themes as prismThemes} from 'prism-react-renderer';
/** @type {import('@docusaurus/types').Config} */
const config = {
title: 'IntelliStream DataHub',
tagline: 'A shared model of your operation',
favicon: 'img/favicon.ico',
// This site publishes at https://intellistream.ai/data-platform-documentation.
// /documentation is already taken by a marketing page on the main site, and the
// SDK docs move alongside these to /sdk-documentation.
// baseUrl matters: every generated asset and route is prefixed with it, so
// the production web server must serve the build under /data-platform-documentation/.
url: 'https://intellistream.ai',
baseUrl: '/data-platform-documentation/',
organizationName: 'intellistream',
projectName: 'datahub-docs',
onBrokenLinks: 'warn',
markdown: {
mermaid: true,
hooks: { onBrokenMarkdownLinks: 'warn' },
},
i18n: { defaultLocale: 'en', locales: ['en'] },
presets: [
[
'classic',
/** @type {import('@docusaurus/preset-classic').Options} */
({
docs: {
sidebarPath: './sidebars.js',
routeBasePath: '/', // docs at site root, GitBook-style
// Adds "Edit this page" to every doc. Docusaurus appends the file's
// path relative to this site directory, so this points at the repo
// root on the default branch — main here, master in datahub-sdk-docs.
editUrl: 'https://github.com/IntelliStream-DataHub/datahub-docs/edit/main/',
},
blog: false,
theme: { customCss: './src/css/custom.css' },
}),
],
],
themes: [
'@docusaurus/theme-mermaid',
[
'@easyops-cn/docusaurus-search-local',
/** @type {import('@easyops-cn/docusaurus-search-local').PluginOptions} */
({
hashed: true,
indexDocs: true,
indexBlog: false,
docsRouteBasePath: '/',
highlightSearchTermsOnTargetPage: true,
}),
],
],
themeConfig:
/** @type {import('@docusaurus/preset-classic').ThemeConfig} */
({
colorMode: { respectPrefersColorScheme: true },
mermaid: {
theme: { light: 'neutral', dark: 'dark' },
options: {
// Diagrams are rendered into a full-width container (see custom.css),
// so bump the base font rather than letting mermaid size for a small canvas.
fontSize: 16,
flowchart: { useMaxWidth: false, nodeSpacing: 55, rankSpacing: 65, padding: 14 },
themeVariables: {
primaryColor: '#eaf2f6',
primaryBorderColor: '#005984',
primaryTextColor: '#1d2b36',
lineColor: '#6b8995',
fontFamily: 'Manrope, Helvetica, Arial, sans-serif',
fontSize: '16px',
},
},
},
navbar: {
title: 'DataHub',
// '/' is the main site root, not this site's baseUrl. That only works
// because src/theme/Logo is ejected to pass href through verbatim —
// stock Docusaurus would rewrite this to /data-platform-documentation/.
logo: {
alt: 'IntelliStream',
src: 'img/logo.svg',
srcDark: 'img/logo-dark.svg',
href: '/',
target: '_self',
},
items: [
{ type: 'docSidebar', sidebarId: 'docsSidebar', position: 'left', label: 'Documentation' },
{ to: '/start/what-is-datahub', label: 'Start here', position: 'left' },
{ to: '/value/business-case', label: 'Business value', position: 'left' },
{ to: '/administration/overview', label: 'Administration', position: 'left' },
// Raw anchors, not `href` items. A Docusaurus <Link> treats any path
// starting with "/" as internal and hands the click to react-router,
// which pushState's the URL and then renders this site's own 404 —
// the href looks right in the HTML but the click never leaves the SPA.
{ type: 'html', position: 'right', value: '<a class="navbar__item navbar__link" href="/sdk-documentation/">Developer & SDK docs</a>' },
{ href: 'https://github.com/IntelliStream-DataHub/datahub-docs', label: 'GitHub', position: 'right' },
],
},
footer: {
style: 'light',
links: [
{
title: 'Start here',
items: [
{ label: 'What DataHub is', to: '/start/what-is-datahub' },
{ label: 'What is Industry 4.0?', to: '/start/industry-4' },
{ label: 'The four building blocks', to: '/start/core-ideas' },
{ label: 'Your first hour', to: '/start/first-hour' },
{ label: 'Glossary', to: '/reference/glossary' },
],
},
{
title: 'Understand the model',
items: [
{ label: 'What is an ontology?', to: '/concepts/ontology' },
{ label: 'Taxonomy vs. ontology', to: '/concepts/taxonomy' },
{ label: 'Knowledge graphs', to: '/concepts/knowledge-graph' },
{ label: 'Contextualization', to: '/concepts/contextualization' },
{ label: 'Naming standards', to: '/concepts/naming-and-standards' },
],
},
{
title: 'For leadership',
items: [
{ label: 'The business case', to: '/value/business-case' },
{ label: 'The cost of doing nothing', to: '/value/cost-of-doing-nothing' },
{ label: 'Where to start', to: '/value/where-to-start' },
{ label: 'AI agents', to: '/value/ai-agents' },
{ label: 'Board briefing', to: '/value/board-briefing' },
],
},
{
title: 'More',
items: [
{ label: 'Administration', to: '/administration/overview' },
{ html: '<a class="footer__link-item" href="/sdk-documentation/">Developer & SDK docs</a>' },
{ html: '<a class="footer__link-item" href="/">intellistream.ai</a>' },
{ html: '<a class="footer__link-item" href="/contact-us">Contact us</a>' },
],
},
],
copyright: `Copyright © ${new Date().getFullYear()} IntelliStream.`,
},
prism: {
theme: prismThemes.github,
darkTheme: prismThemes.dracula,
additionalLanguages: ['java', 'python', 'bash', 'json', 'yaml', 'sql'],
},
}),
};
export default config;