osirisjson-docs/astro.config.mjs at main · osirisjson/osirisjson-docs · GitHub

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
// @ts-check
import { defineConfig } from 'astro/config';
import starlight from '@astrojs/starlight';
import mermaid from 'astro-mermaid';
import sitemap from '@astrojs/sitemap';

export default defineConfig({
	site: 'https://docs.osirisjson.org',
	integrations: [
		mermaid({
			theme: 'default',
			autoTheme: false,
		}),
		starlight({
			title: 'OSIRIS JSON Docs',
			logo: {
				src: './src/assets/logo/osiris-logo-color-positive.svg',
				alt: 'OSIRIS JSON',
				replacesTitle: true,
			},
			customCss: ['./src/styles/osiris-theme.css'],
			editLink: {
				baseUrl: 'https://github.com/osirisjson/osirisjson-docs/edit/dev/',
			},
			expressiveCode: {
				styleOverrides: {
					borderRadius: '0.5rem',
					borderColor: 'var(--osiris-table-border)',
					codeBackground: 'var(--osiris-code-bg)',
				},
			},
			components: {
				Header: './src/components/Header.astro',
				ThemeProvider: './src/components/ThemeProvider.astro',
				MobileMenuFooter: './src/components/MobileMenuFooter.astro',
				MobileMenuToggle: './src/components/MobileMenuToggle.astro',
				EditLink: './src/components/EditLink.astro',
				Footer: './src/components/Footer.astro',
				PageTitle: './src/components/PageTitle.astro',
				Head: './src/components/Head.astro',
				TableOfContents: './src/components/TableOfContents.astro',
			},
			sidebar: [
				{
					label: 'Introduction',
					items: [
						{ label: 'Welcome', slug: 'introduction/welcome' },

						{ label: 'Real-world use cases', slug: 'introduction/use-cases' },
						{ label: 'What is OSIRIS JSON', slug: 'introduction/what-is-osiris' },
					],
				},
				{
					label: 'OSIRIS JSON Consumers',
					items: [{ label: 'Getting started', slug: 'osiris-consumers/getting-started' }],
				},
				{
					label: 'OSIRIS JSON Producers',
					items: [
						{ label: 'Getting started', slug: 'osiris-producers/getting-started' },
						{ label: 'How to install', slug: 'osiris-producers/installation' },
						{ label: 'Security', slug: 'osiris-producers/security' },
						{
							label: 'Network',
							items: [
								{ label: 'Cisco', slug: 'osiris-producers/network/cisco' },
								{ label: 'HPE', slug: 'osiris-producers/network/hpe-aruba-networking-central' },
							],
						},
						{
							label: 'Hyperscalers',
							items: [
								{ label: 'Microsoft Azure', slug: 'osiris-producers/hyperscalers/microsoft-azure' },
								{ label: 'Amazon AWS', slug: 'osiris-producers/hyperscalers/amazon-aws' },
							],
						},
					],
				},

				{
					label: 'Examples',
					items: [
						{ label: 'IT infrastructure examples', slug: 'examples/it-infrastructure' },
						{ label: 'OT infrastructure examples', slug: 'examples/ot-infrastructure' },
					],
				},
				{
					label: 'Validate',
					items: [
						{ label: 'Toolbox CLI', slug: 'validate/toolbox-cli' },
						{ label: 'Validation levels', slug: 'validate/validation-levels' },
					],
				},
				{
					label: 'Developer guidelines',
					items: [
						{ label: 'Welcome', slug: 'developer-guidelines/welcome' },
						{ label: 'Architecture guidelines', slug: 'developer-guidelines/architecture' },
						{
							label: 'Producers',
							items: [
								{
									label: 'Producer guidelines',
									slug: 'developer-guidelines/producers/producer-guidelines',
								},
								{ label: 'Producer SDK', slug: 'developer-guidelines/producers/producer-sdk' },
								{
									label: 'Writing a producer',
									slug: 'developer-guidelines/producers/writing-a-producer',
								},
							],
						},
					],
				},
				{
					label: 'Community',
					items: [
						{
							label: 'Style guidelines',
							items: [
								{
									label: 'Introduction',
									slug: 'community/style-guidelines/introduction',
								},
								{
									label: 'Components',
									slug: 'community/style-guidelines/components',
								},
							],
						},
						{ label: 'Contributing', slug: 'community/contributing' },
						{ label: 'Support', slug: 'community/support' },
					],
				},
			],
		}),
		sitemap(),
	],
	vite: {
		build: {
			cssMinify: 'esbuild',
		},
	},
});