Doc: Refactored documentation, split it into smaller articles, and added search (#9132)

2025-11-26 22:41:17 +02:00 · 2023-10-30 11:32:14 +00:00
parent f94cc0fe3c
commit 5f6370d7ba
237 changed files with 11124 additions and 3131 deletions
--- a/packages/doc-builder/docusaurus.config.js
+++ b/packages/doc-builder/docusaurus.config.js
@@ -0,0 +1,174 @@
+// @ts-check
+// Note: type annotations allow type checking and IDEs autocompletion
+
+const lightCodeTheme = require('prism-react-renderer/themes/github');
+const darkCodeTheme = require('prism-react-renderer/themes/dracula');
+
+// To make their weird linter happy
+process.env.WEBSITE_BASE_URL = process.env.WEBSITE_BASE_URL || '';
+
+/** @type {import('@docusaurus/types').Config} */
+const config = {
+	title: 'Joplin',
+	tagline: 'Free your notes!',
+	favicon: 'img/favicon.ico',
+
+	// Set the production url of your site here
+	url: process.env.WEBSITE_BASE_URL,
+	// Set the /<baseUrl>/ pathname under which your site is served
+	// For GitHub pages deployment, it is often '/<projectName>/'
+	baseUrl: '/',
+
+	onBrokenLinks: 'throw',
+	onBrokenMarkdownLinks: 'warn',
+
+	// 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: 'en',
+		locales: ['en'],
+	},
+
+	plugins: [
+		[
+			require.resolve('docusaurus-lunr-search'),
+			{
+				// Options here
+			},
+		],
+	],
+
+	presets: [
+		[
+			'classic',
+			/** @type {import('@docusaurus/preset-classic').Options} */
+			({
+				docs: {
+					path: 'help',
+					routeBasePath: 'help',
+					sidebarPath: require.resolve('./sidebars.js'),
+					breadcrumbs: false,
+					editUrl: (params) => {
+						return 'https://github.com/laurent22/joplin/tree/dev/readme/' + params.docPath;
+					},
+				},
+				blog: {
+					showReadingTime: true,
+					blogSidebarCount: 'ALL',
+					path: 'news',
+					routeBasePath: 'news',
+					editUrl: (params) => {
+						return 'https://github.com/laurent22/joplin/tree/dev/readme/news/' + params.blogPath;
+					},
+				},
+				theme: {
+					customCss: require.resolve('./src/css/custom.css'),
+				},
+				sitemap: {
+					changefreq: 'weekly',
+					priority: 0.5,
+					filename: 'sitemap.xml',
+				},
+			}),
+		],
+	],
+
+	themeConfig:
+		/** @type {import('@docusaurus/preset-classic').ThemeConfig} */
+		({
+			navbar: {
+				title: '',
+				logo: {
+					alt: 'Joplin',
+					src: 'images/logo-text-blue.svg',
+					href: process.env.WEBSITE_BASE_URL,
+					target: '_self',
+				},
+				items: [
+					{
+						to: '/news',
+						label: 'News',
+						position: 'right',
+					},
+					{
+						type: 'docSidebar',
+						sidebarId: 'helpSidebar',
+						position: 'right',
+						label: 'Help',
+					},
+					{
+						to: 'https://discourse.joplinapp.org',
+						label: 'Forum',
+						position: 'right',						
+					},
+					{
+						to: process.env.WEBSITE_BASE_URL + '/plans',
+						label: 'Joplin Cloud',
+						position: 'right',
+						className: 'navbar-custom-buttons plans-button',
+					},
+					{
+						to: process.env.WEBSITE_BASE_URL + '/donate',
+						label: '♡ Support us',
+						position: 'right',
+						className: 'navbar-custom-buttons sponsor-button',
+					},
+				],
+			},
+			footer: {
+				style: 'dark',
+				links: [
+					{
+						title: 'Community',
+						items: [
+							{
+								label: 'Twitter',
+								href: 'https://twitter.com/joplinapp',
+							},
+							{
+								label: 'Patreon',
+								href: 'https://www.patreon.com/joplin',
+							},
+							{
+								label: 'LinkedIn',
+								href: 'https://www.linkedin.com/company/joplin',
+							},
+							{
+								label: 'Discord',
+								href: 'https://discord.gg/VSj7AFHvpq',
+							},
+							{
+								label: 'Mastodon',
+								href: 'https://mastodon.social/@joplinapp',
+							},
+							{
+								label: 'Lemmy',
+								href: 'https://sopuli.xyz/c/joplinapp',
+							},
+							{
+								label: 'GitHub',
+								href: 'https://github.com/laurent22/joplin/',
+							},
+						],
+					},
+					{
+						title: 'Legal',
+						items: [
+							{
+								label: 'Privacy Policy',
+								to: process.env.WEBSITE_BASE_URL + '/privacy',
+							},
+						],
+					},
+				],
+				copyright: `Copyright © 2016-${new Date().getFullYear()} Laurent Cozic`,
+			},
+			prism: {
+				theme: lightCodeTheme,
+				darkTheme: darkCodeTheme,
+			},
+		}),
+};
+
+module.exports = config;