n8n-docs/docs/.vuepress/config.js

const dirTree = require('directory-tree');
const path = require('path');

function getChildrenFiles(folder, topItem) {
	const returnFiles = dirTree(path.join(__dirname, `../${folder}`), { extensions: /\.md/ }).children
		.filter(page => {
			return page.type === 'file' && page.name !== 'README.md';
		})
		.sort((a, b) => {
			const aName = a.name.toLowerCase();
			const bName = b.name.toLowerCase();
			if (aName < bName) { return -1; }
			if (aName > bName) { return 1; }
			return 0;
		})
		.map(page => {
			return `/${folder}/${page.name}`;
		});

	if (topItem !== undefined) {
		const topItemPath = `/${folder}/${topItem}`;
		const index = returnFiles.indexOf(topItemPath);
		if (index !== -1) {
			returnFiles.splice(index, 1);
			returnFiles.unshift(topItemPath);
		}
	}

	return returnFiles;
}

function getChildrenFolders(folder) {
	return dirTree(path.join(__dirname, `../${folder}`), { extensions: /\.md/ }).children
		.filter(page => {
			return page.type === 'directory' && !!page.children.find(child => child.name === 'README.md');
		})
		.sort((a, b) => {
			const aName = a.name.toLowerCase();
			const bName = b.name.toLowerCase();
			if (aName < bName) { return -1; }
			if (aName > bName) { return 1; }
			return 0;
		})
		.map(page => {
			return `/${folder}/${page.name}/`;
		});
}

function getDescription(frontmatterDescription, permalink) {
	var description = 'n8n is an extendable workflow automation tool that enables you to connect anything to everything via its open, fair-code model.';
	var nodePath = /\/nodes\/n8n-nodes-base/;
	var credentialPath = /\/credentials\//;
	if (frontmatterDescription) {
		if (nodePath.test(permalink) || credentialPath.test(permalink)) {
			description = `${frontmatterDescription}, an extendable workflow automation tool that enables you to connect anything to everything via its open, fair-code model.`;
		} else {
			description = frontmatterDescription;
		}
	}
	return description;
}

module.exports = {
	description: 'Documentation for n8n',
	title: 'Docs',
	plugins: [
		'vuepress-plugin-reading-time',
		'@vuepress/last-updated',
		[
			'vuepress-plugin-code-copy',
			true,
		],
		[
			'seo',
			{
				description: $page => getDescription($page.frontmatter.description, $page.frontmatter.permalink),
				title: ($page, $site) => `${$page.title} | n8n ${$site.title}`,
				image: () => 'https://n8n.io/n8n-logo.png',
				modifiedAt: $page => $page.lastUpdated && new Date($page.lastUpdated),
				url: (_, $site, path) => ($site.themeConfig.domain || '') + path,
			}
		],
		[
			'@vuepress/google-analytics',
			{
				'ga': 'UA-146470481-3',
			},
		],
		[
			'sitemap',
			{
				hostname: 'https://docs.n8n.io'
			},
		]
	],
	themeConfig: {
		repo: 'n8n-io/n8n',
		base: '/n8n-docs/',
		docsRepo: 'n8n-io/n8n-docs',
		docsDir: 'docs',
		editLinks: true,
		editLinkText: 'Help us improve this page!',
		smoothScroll: true,
		lastUpdated: true,
		sidebarDepth: 2,
		algolia: {
			apiKey: '36968f1949f14fc25079286688915dc9',
			indexName: 'n8n_io',
		},
		searchPlaceholder: 'Search...',
		logo: '/assets/img/n8n-logo.png',
		nav: [
			{
				text: 'Getting Started',
				link: '/',
			},
			// {
			// 	text: 'Guides',
			// 	link: '/guides/guides.md'
			// },
			{
				text: 'Nodes',
				link: '/nodes/nodes.md',
			},
			{
				text: 'Reference',
				link: '/reference/reference.md',
			},
			{
				text: 'Community',
				link: 'https://community.n8n.io',
			},
		],
		sidebar: {
			// '/guides/': [
			// 	{
			// 		title: 'Guide Overview',
			// 		sidebarDepth: 2,
			// 		children: getChildrenFiles('guides', 'guides.md'),
			// 	},
			// ],

			'/nodes/': [
				{
					title: '🧬 Overview',
					sidebarDepth: 2,
					children: [
						{
							title: 'Node Overview',
							sidebarDepth: 2,
							path: 'nodes.md',
						},
						{
							title: 'Node Basics',
							sidebarDepth: 2,
							path: 'node-basics.md',
						},
						{
							title: 'Expressions',
							sidebarDepth: 2,
							path: 'expressions.md',
						},
					]
				},
				{
					title: '🔬 Creating Nodes',
					sidebarDepth: 2,
					children: getChildrenFiles('nodes/creating-nodes', 'create-node.md'),
				},
				{
					title: '🧠 Nodes Library',
					sidebarDepth: 3,
					children: [
						{
							title: 'Core Nodes',
							sidebarDepth: 1,
							children: getChildrenFolders('nodes/nodes-library/core-nodes'),
						},
						{
							title: 'Nodes',
							sidebarDepth: 1,
							children: getChildrenFolders('nodes/nodes-library/nodes'),
						},
						{
							title: 'Trigger Nodes',
							sidebarDepth: 1,
							children: getChildrenFolders('nodes/nodes-library/trigger-nodes'),
						},
					],
				},
				{
					title: '🔑 Credentials Library',
					sidebarDepth: 2,
					children: getChildrenFolders('nodes/credentials'),
				},
			],

			'/reference/': [
				{
					title: '📚 Overview',
					path: 'reference.md',
				},
				{
					title: '🧐 Changelog',
					path: 'changelog.md',
				},
				{
					title: '🎯 Workflow',
					path: 'workflow.md',
				},
				{
					title: '⚙️ Configuration',
					path: 'configuration.md',
				},
				{
					title: '🚔 Security',
					path: 'security.md',
				},
				{
					title: '📦 Docker',
					path: 'docker.md',
				},
				{
					title: '🖥 Server Setup',
					path: 'server-setup.md',
				},
				{
					title: '👾 CLI commands for n8n',
					path: 'start-workflows-via-cli.md',
				},
				{
					title: '💪 JavaScript Code Snippets',
					path: 'javascript-code-snippets.md',
				},
				{
					title: '💭 Glossary',
					path: 'glossary.md',
				},
				{
					title: '💡 Function and Function Item Nodes',
					path: 'function-nodes.md',
				},
				{
					title: '👀 Troubleshooting',
					path: 'troubleshooting.md',
				},
				{
					title: '💾 Data',
					sidebarDepth: 2,
					children: getChildrenFiles('reference/data'),
				},
				{
					title: '🙌 Contributing',
					path: 'contributing.md',
				},
				{
					title: '⌨️ Keyboard Shortcuts',
					path: 'keyboard-shortcuts.md',
				},
				{
					title: '🎫 License',
					path: 'license.md',
				},
				{
					title: '❓ FAQ',
					path: 'faq.md',
				},
			],

			'/': [
				{
					title: '👋 Introduction',
					collapsable: false,
					path: '/',
					sidebarDepth: 0,
				},
				{
					title: '🚀 Quickstart',
					path: 'getting-started/quickstart.md',
				},
				{
					title: '🍄 Key Components',
					path: 'getting-started/key-components.md',
				},
				{
					title: '💪 Create Your First Workflow',
					children: getChildrenFolders('getting-started/create-your-first-workflow'),

				},
				{
					title: '🤘 Tutorials',
					path: 'getting-started/tutorials.md',
				},
				{
					title: '🤔 What\'s Next?',
					path: 'getting-started/whats-next.md',
				},
			],
			// [
			// {
			// 	title: 'Introduction',
			// 	sidebarDepth: 2,
			// 	children: [
			// 		'getting-started/overview.md',
			// 		'getting-started/node-basics.md',
			// 		'getting-started/workflow.md',
			// 		'getting-started/start-workflows-via-cli.md',
			// 	],
			// },
			// ]
		}
	},
}