archived-tauri-docs/astro.config.mjs

import { defineConfig } from 'astro/config';
import starlight from '@astrojs/starlight';
import { rehypeHeadingIds } from '@astrojs/markdown-remark';
import rehypeAutolinkHeadings from 'rehype-autolink-headings';
import locales from './locales.json';
import configGenerator from './src/plugins/configGenerator';
import starlightLinksValidator from 'starlight-links-validator';
import starlightBlog from 'starlight-blog';

await configGenerator();

const authors = {
	nothingismagick: {
		name: 'Daniel Thompson-Yvetot',
		title: 'Tauri Co-Founder',
		picture: '/authors/nothingismagick.jpeg',
	},
	lucasfernog: {
		name: 'Lucas Nogueira',
		title: 'Tauri Co-Founder',
		picture: '/authors/lucasfernog.jpeg',
	},
	beanow: {
		name: 'Robin van Boven',
		title: 'Tauri Board Director',
		picture: '/authors/Beanow.png',
	},
	jbolda: {
		name: 'Jacob Bolda',
		title: 'Tauri Board Director',
		picture: '/authors/jbolda.jpeg',
	},
	lorenzolewis: {
		name: 'Lorenzo Lewis',
		title: 'Tauri Community Lead',
		picture: '/authors/lorenzolewis.png',
	},
	tweidinger: {
		name: 'Tillmann Weidinger',
		title: 'Tauri Security',
		picture: '/authors/tweidinger.png',
	},
	amrbashir: {
		name: 'Amr Bashir',
		title: 'Tauri Development',
		picture: '/authors/amrbashir.png',
	},
	wusyong: {
		name: 'Wu Yu Wei',
		title: 'Tauri Development Lead',
		picture: '/authors/wusyong.png',
	},
};

const site = 'https://beta.tauri.app'

// https://astro.build/config
export default defineConfig({
	site,
	integrations: [
		starlightLinksValidator(),
		starlightBlog({ authors }),
		starlight({
			title: 'Tauri',
			description: 'The cross-platform app building toolkit',
			logo: {
				dark: './src/assets/logo.svg',
				light: './src/assets/logo_light.svg',
				replacesTitle: true,
			},
			social: {
				github: 'https://github.com/tauri-apps/tauri',
				discord: 'https://discord.com/invite/tauri',
				twitter: 'https://twitter.com/TauriApps',
				mastodon: 'https://fosstodon.org/@TauriApps',
			},
			head: [
				{
					tag: 'meta',
					attrs: { property: 'og:image', content: site + '/og.png?v=1' },
				},
				{
					tag: 'meta',
					attrs: { property: 'twitter:image', content: site + '/og.png?v=1' },
				},
			],
			// TODO: Be sure this is updated when the branch is switched
			editLink: {
				baseUrl: 'https://github.com/tauri-apps/tauri-docs/edit/next',
			},
			customCss: ['./src/styles/custom.css'],
			sidebar: [
				{
					label: 'Quick Start',
					items: [
						{ label: 'Why Tauri?', link: '/2/guide/' },
						{
							label: 'Prerequisites',
							translations: {
								es: 'Prerrequisitos',
							},
							link: '/2/guide/prerequisites',
						},
						{
							label: 'Create a Project',
							link: '/2/guide/create/',
						},
						{
							label: 'Frontend Configuration',
							translations: {
								es: 'Configuración del Frontend',
							},
							link: '/2/guide/frontend/',
						},
						{
							label: 'Upgrade & Migrate',
							link: '2/guide/upgrade-migrate',
						},
						{
							label: 'Core Concepts',
							link: '2/guide/core-concepts',
						},
						{
							label: 'Troubleshooting',
							link: '2/guide/troubleshoot',
						},
					],
				},
				{
					label: 'Guides',
					items: [
						{
							label: 'Develop',
							link: '2/guide/develop',
						},
						{
							label: 'Debug',
							link: '2/guide/debug',
						},
						{
							label: 'Test',
							link: '2/guide/test',
						},
						{
							label: 'Build',
							link: '2/guide/build',
						},
						{
							label: 'Distribute',
							link: '2/guide/distribute',
						},
						{
							label: 'Plugin Development',
							link: '2/guide/plugins',
						},
					],
				},
				{
					label: 'References',
					items: [
						{
							label: 'Tauri Configuration',
							link: '2/reference/config',
						},
						{
							label: 'Command Line Interface (CLI)',
							link: '2/reference/cli',
						},
						{
							label: 'JavaScript API',
							link: '2/reference/js',
						},
						{
							label: 'Rust API (via Docs.rs)',
							// TODO: Is there a way to link this to the latest pre-released version?
							link: 'https://docs.rs/tauri/~2.0.0-alpha',
						},
					],
				},
				{
					label: 'Features & Recipes',
					items: [
						{ label: 'All Features and Recipes', link: '2/guide/list' },
						{ label: 'Authenticator', link: '2/guide/authenticator' },
						{ label: 'Autostart', link: '2/guide/autostart' },
						{ label: 'CLI', link: '2/guide/cli' },
						{ label: 'Clipboard', link: '2/guide/clipboard' },
						{ label: 'Dialog', link: '2/guide/dialog' },
						{ label: 'File System', link: '2/guide/file-system' },
						{ label: 'Global Shortcut', link: '2/guide/global-shortcut' },
						{ label: 'HTTP Client', link: '2/guide/http-client' },
						{ label: 'Localhost', link: '2/guide/localhost' },
						{ label: 'Logging', link: '2/guide/logging' },
						{ label: 'Notification', link: '2/guide/notification' },
						{ label: 'OS Info', link: '2/guide/os-info' },
						{ label: 'Persisted Scope', link: '2/guide/persisted-scope' },
						{ label: 'Positioner', link: '2/guide/positioner' },
						{ label: 'Process', link: '2/guide/process' },
						{ label: 'Shell', link: '2/guide/shell' },
						{ label: 'Single Instance', link: '2/guide/single-instance' },
						{ label: 'SQL', link: '2/guide/sql' },
						{ label: 'Store', link: '2/guide/store' },
						{ label: 'Stronghold', link: '2/guide/stronghold' },
						{ label: 'Updater', link: '2/guide/updater' },
						{ label: 'Upload', link: '2/guide/upload' },
						{ label: 'Websocket', link: '2/guide/websocket' },
						{ label: 'Window Customization', link: '2/guide/window-customization' },
						{ label: 'Window State', link: '2/guide/window-state' },
					],
				},
			],
			locales,
			lastUpdated: true,
		}),
	],
	markdown: {
		shikiConfig: {
			langs: ['powershell'],
		},
		rehypePlugins: [
			rehypeHeadingIds,
			[
				rehypeAutolinkHeadings,
				{
					behavior: 'wrap',
					properties: { ariaHidden: true, tabIndex: -1, class: 'heading-link' },
				},
			],
		],
	},
	redirects: {
		// Old blog url schema redirects
		'/blog/2022-06-19-tauri-1-0': '/blog/tauri-1-0',
		'/blog/tauri_1_0': '/blog/tauri-1-0',
		'/blog/2022-07-12-tauri-programme-turns-1-and-board-elections':
			'/blog/tauri-programme-turns-1-and-board-elections',
		'/blog/2022-09-15-tauri-1-1': '/blog/tauri-1-1',
		'/blog/2022-09-19-tauri-egui-0-1': '/blog/tauri-egui-0-1',
		'/blog/2022-11-18-tauri-1-2': '/blog/tauri-1-2',
		'/blog/2022-12-09-tauri-mobile-alpha': '/blog/tauri-mobile-alpha',
		'/blog/2023-02-03-tauri-2-0-0-alpha-3': '/blog/tauri-2-0-0-alpha-3',
		'/blog/2023-02-09-tauri-community-growth-and-feedback':
			'/blog/tauri-community-growth-and-feedback',
		'/blog/2023-03-01-create-tauri-app-version-3-released':
			'/blog/create-tauri-app-version-3-released',
		'/blog/2023-03-20-tauri-2-0-0-alpha-4': '/blog/tauri-2-0-0-alpha-4',
		'/blog/2023-05-03-tauri-1-3': '/blog/tauri-1-3',
		'/blog/2023-06-14-tauri-1-4': '/blog/tauri-1-4',
		'/blog/2023-06-15-tauri-board-elections-and-governance-updates':
			'/blog/tauri-board-elections-and-governance-updates',
	},
});