Replace documentation with new vitepress based documentation

Author: cmouse

.github/workflows/ci.yml

@@ -3,16 +3,18 @@ name: CI
 on: pull_request
 
 jobs:
-
   build:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v4
-    - name: Prepare manpages
-      run: |
-        for path in source/man source/*-man; do
-          if [ -d $path ]; then
-            make -C $path
-          fi
-        done
-    - uses: dovecot/[email protected]
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Setup Node
+        uses: actions/setup-node@v3
+        with:
+          node-version: 20
+          cache: npm
+      - name: Install Dependencies
+        run: npm ci
+      - name: Build with VitePress
+        run: |
+          npm run docs:build

.vitepress/config.js

@@ -0,0 +1,106 @@
+import path from 'path'
+import { defineConfig } from 'vitepress'
+import { pagefindPlugin } from 'vitepress-plugin-pagefind'
+import { generateSidebar } from 'vitepress-sidebar'
+import { dovecotMdExtend } from '../lib/markdown.js'
+import { frontmatterIter } from '../lib/utility.js'
+
+const base = '/dovecot-ce-documentation'
+
+// No need to include the "dummy" index files, used to build titles
+// for the sidebar, into the final documentation bundles
+const excludes = []
+await frontmatterIter(function (f, data) {
+	if (data.exclude) {
+		excludes.push(path.relative('docs/', f))
+	}
+})
+
+export default defineConfig({
+	title: "Dovecot CE",
+	description: "Dovecot CE Documentation",
+	lang: "en-us",
+
+	srcDir: "docs",
+	srcExclude: excludes,
+
+	base: base,
+	sitemap: {
+		hostname: 'https://doc.dovecot.org' + base
+	},
+
+	vite: {
+		build: {
+			chunkSizeWarningLimit: 1000,
+		},
+		plugins: [
+			pagefindPlugin()
+		],
+	},
+
+	ignoreDeadLinks: 'localhostLinks',
+
+	themeConfig: {
+		nav: [
+			{
+				text: '2.4',
+				items: [
+					{ text: '2.3', link: 'https://doc.dovecot.org/' },
+				]
+			},
+			{
+				text: 'Dovecot Home',
+				link: 'https://www.dovecot.org/'
+			},
+			{
+				text: 'Repositories',
+				link: 'https://repo.dovecot.org/'
+			},
+		],
+
+		sidebar: generateSidebar({
+			documentRootPath: '/docs',
+			useTitleFromFrontmatter: true,
+			useFolderTitleFromIndexFile: true,
+			includeFolderIndexFile: true,
+			collapseDepth: 1,
+			excludeFiles: [],
+			excludeFilesByFrontmatterName: 'exclude',
+			sortMenusByName: true,
+		}),
+
+		outline: "deep",
+		externalLinkIcon: true,
+		lastUpdated: {},
+
+		docFooter: {
+			prev: false,
+			next: false,
+		},
+		footer: {
+			copyright: 'Copyright © Open-Xchange GmbH',
+		},
+
+		logo: '/dovecot_logo.png',
+
+		editLink: {
+			pattern: 'https://github.com/dovecot/documentation/edit/main/docs/:path'
+		},
+
+		socialLinks: [
+			{ icon: 'github', link: 'https://github.com/dovecot/core/' },
+		],
+	},
+
+	markdown: {
+		config: async (md) => await dovecotMdExtend(md),
+		image: {
+			lazyLoading: true,
+		},
+		math: true,
+	},
+
+	head: [
+		['link', { rel: 'icon', type: 'image/x-icon', href: base + '/favicon.ico' } ]
+	],
+})

.vitepress/local.js.dist

@@ -0,0 +1,47 @@
+/* This file allows configuration overwrite of default paths. */
+
+// Allows custom mapping of data sources.
+// It is used by the VitePress data loaders to determine what data to
+// load for export.
+//
+// By default, all data files are loaded from "../data" directory
+// (paths are relative to "<base>/lib").
+//
+// Keys are data identifiers, Values are location RELATIVE TO
+// * "<base>/lib" DIRECTORY.
+export const data_paths = {
+	// doveadm: '../data/doveadm.js',
+}
+
+// A listing of source files (.md) for the documentation.
+// Paths are relative to project base.
+//
+// Supports fast-glob: https://github.com/mrmlnc/fast-glob#pattern-syntax
+//
+// Default: [ 'docs/**/*.md' ]
+export const source_paths = []
+
+// A listing of files to watch to refresh data loaders in dev mode.
+// See: https://vitepress.dev/guide/data-loading#data-from-local-files
+// Paths are relative to project base.
+//
+// Supports fast-glob: https://github.com/mrmlnc/fast-glob#pattern-syntax
+//
+// Default: [ 'docs/**/*.md', 'docs/**/*.inc', 'data/**/*' ]
+export const watch_paths = []
+
+// A listing of source path translations.
+//
+// This is the same format as VitePress' 'rewrite' setting:
+//   https://vitepress.dev/reference/site-config#rewrites
+//
+// Default: {}
+export const source_path_translations = {}
+
+// A listing of paths containing man files.
+// Paths are relative to project base.
+//
+// Supports fast-glob: https://github.com/mrmlnc/fast-glob#pattern-syntax
+//
+// Default: [ 'docs/core/man/*.[[:digit:]].md' ]
+export const man_paths = []

.vitepress/theme/index.js

@@ -0,0 +1,19 @@
+import DefaultTheme from 'vitepress/theme'
+
+const modules = import.meta.glob(
+	'../../components/*.vue',
+	{
+		eager: true
+	}
+)
+
+export default {
+	extends: DefaultTheme,
+	/* This code loads all .vue components and globally registers them. */
+	enhanceApp({ app }) {
+		for (const path in modules) {
+			const c = modules[path].default
+			app.component(c.__name, c)
+		}
+	}
+}