docusaurus.config.js

// @ts-check
// Note: type annotations allow type checking and IDEs autocompletion

const { themes } = require('prism-react-renderer');

const PUBLIC_BASE_URL = 'https://public-ui.github.io';

/** @type {import('@docusaurus/types').Config} */
const config = {
	title: 'KoliBri - Public UI',
	tagline: 'The accessible Web Component Library',
	url: PUBLIC_BASE_URL,
	baseUrl: '/',
	onBrokenLinks: 'throw',
	trailingSlash: false,
	onBrokenMarkdownLinks: 'warn',
	favicon: 'assets/favicon.ico',

	// GitHub pages deployment config.
	// If you aren't using GitHub pages, you don't need these.
	organizationName: 'Informationstechnikzentrum Bund (ITZBund)', // Usually your GitHub org/user name.
	projectName: 'KoliBri (Public-UI)', // Usually your repo name.

	// Even if you don't use internalization, 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: 'de',
		locales: ['de', 'en'],
	},

	presets: [
		[
			'classic',
			/** @type {import('@docusaurus/preset-classic').Options} */
			({
				docs: {
					sidebarCollapsible: true,
					sidebarPath: require.resolve('./sidebars.js'),
					// Remove this to remove the "edit this page" links.
					// editUrl: 'https://github.com/public-ui/documentation/blob/main/packages/docusaurus/',
					// lastVersion: 'current',
					// versions: {
					// 	current: {
					// 		label: '1.1',
					// 		path: 'v1',
					// 	},
					// },
				},
				blog: {
					blogDescription:
						'Im Blog greifen wir verschiedene interessant und hilfreiche Themen rund um barrierefreie Webcomponents auf.',
					blogSidebarTitle: 'Neueste Posts',
					postsPerPage: 3,
					blogSidebarCount: 10,
					feedOptions: {
						createFeedItems: async (params) => {
							const { blogPosts, defaultCreateFeedItems, ...rest } = params;
							return defaultCreateFeedItems({
								// keep only the 10 most recent blog posts in the feed
								blogPosts: blogPosts.filter((_, index) => index < 10),
								...rest,
							});
						},
					},
					showReadingTime: true,
					// Please change this to your repo.
					// Remove this to remove the "edit this page" links.
					// editUrl: 'https://github.com/public-ui/documentation/blob/main/packages/docusaurus/',
					onUntruncatedBlogPosts: 'ignore',
				},
				sitemap: {
					changefreq: 'daily',
					priority: 0.5,
					ignorePatterns: ['/blog/tags/**', '/docs/tags/**'],
					filename: 'sitemap.xml',
				},
				theme: {
					customCss: require.resolve('./src/css/custom.css'),
				},
			}),
		],
	],

	themeConfig:
		/** @type {import('@docusaurus/preset-classic').ThemeConfig} */
		({
			navbar: {
				title: 'KoliBri',
				logo: {
					alt: 'KoliBri Logo',
					src: 'assets/logo.kolibri.png',
				},
				items: [
					{
						label: 'Version 3',
						position: 'right',
						items: [
							{
								type: 'html',
								className: 'dropdown-archived-versions',
								value: '<strong class="dropdown__link">Version 3</strong>',
							},
							{ to: `${PUBLIC_BASE_URL}/v2/`, label: 'Version 2' },
							{
								type: 'html',
								value: '<hr class="dropdown-separator">',
							},
							{
								type: 'html',
								className: 'dropdown-archived-versions',
								value: '<span class="dropdown__link">Version 1</span>',
							},
						],
					},
					{
						label: 'Dokumentation',
						to: '/docs',
						position: 'left',
					},
					{
						to: '/blog',
						label: 'Blog',
						position: 'left',
					},
					{
						type: 'search',
						position: 'right',
					},
				],
			},
			footer: {
				style: 'dark',
				links: [
					{
						title: 'Inhalte',
						items: [
							{
								label: 'Dokumentation',
								to: '/docs',
							},
							{
								label: 'Blog',
								to: '/blog',
							},
							{
								label: 'Impressum',
								to: '/docs/impressum',
							},
						],
					},
					{
						title: 'Community',
						items: [
							{
								label: 'Community of Practices',
								href: 'https://github.com/public-ui/kolibri/discussions/516',
							},
							{
								label: 'FAQ',
								href: 'https://github.com/public-ui/kolibri/discussions',
							},
							{
								label: 'Mastodon',
								href: 'https://social.bund.de/@kolibri',
							},
						],
					},
					{
						title: 'Mehr',
						items: [
							{
								label: 'GitHub',
								href: 'https://github.com/public-ui',
							},
							{
								label: 'ITZBund',
								href: 'https://itzbund.de',
							},
							{
								label: 'Portal Barrierefreiheit',
								href: 'https://www.barrierefreiheit-dienstekonsolidierung.bund.de/',
							},
						],
					},
				],
				copyright: `© Informationstechnikzentrum Bund (ITZBund) 2020 - ${new Date().getFullYear()}`,
			},
			prism: {
				theme: themes.vsLight,
				darkTheme: themes.vsDark,
				additionalLanguages: ['diff'],
			},
			mermaid: {
				theme: {
					light: 'neutral',
					dark: 'forest',
				},
			},
		}),
	markdown: {
		mermaid: true,
	},
	plugins: [
		async () => {
			return {
				name: 'docusaurus-tailwindcss',
				configurePostCss(postcssOptions) {
					// Appends TailwindCSS and AutoPrefixer.
					postcssOptions.plugins.push(require('tailwindcss'));
					postcssOptions.plugins.push(require('autoprefixer'));
					return postcssOptions;
				},
			};
		},
		// [
		// 	// https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-ideal-image
		// 	'@docusaurus/plugin-ideal-image',
		// 	{
		// 		quality: 70,
		// 		max: 1030, // max resized image's size.
		// 		min: 640, // min resized image's size. if original is lower, use that size.
		// 		steps: 2, // the max number of images generated between min and max (inclusive)
		// 		disableInDev: false,
		// 	},
		// ],
		// [
		// 	// https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-pwa
		// 	'@docusaurus/plugin-pwa',
		// 	{
		// 		debug: true,
		// 		offlineModeActivationStrategies: ['appInstalled', 'standalone', 'queryString'],
		// 		pwaHead: [
		// 			{
		// 				tagName: 'link',
		// 				rel: 'icon',
		// 				href: '/img/docusaurus.png',
		// 			},
		// 			{
		// 				tagName: 'link',
		// 				rel: 'manifest',
		// 				href: '/manifest.json', // your PWA manifest
		// 			},
		// 			{
		// 				tagName: 'meta',
		// 				name: 'theme-color',
		// 				content: 'rgb(37, 194, 160)',
		// 			},
		// 		],
		// 	},
		// ],
		// 'docusaurus-plugin-sass',
		[
			'@docusaurus/plugin-client-redirects',
			{
				redirects: [
					{
						from: '/docs/get-started/erste-schritte',
						to: '/docs/get-started/first-steps',
					},
				],
			},
		],
		// docu/origin: https://github.com/praveenn77/docusaurus-lunr-search
		require.resolve('docusaurus-lunr-search'),
	],
	themes: ['@docusaurus/theme-mermaid'],
};

module.exports = config;