diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js
index 39b0c8650..2cce73b93 100644
--- a/docs/docusaurus.config.js
+++ b/docs/docusaurus.config.js
@@ -2,7 +2,7 @@ const lightCodeTheme = require('prism-react-renderer/themes/github');
const darkCodeTheme = require('prism-react-renderer/themes/dracula');
const path = require('path');
-/** @type {import('@docusaurus/types').DocusaurusConfig} */
+/** @type {import('@docusaurus/types').Config} */
module.exports = {
title: 'Woodpecker CI',
tagline: 'Woodpecker is a simple CI engine with great extensibility.',
@@ -14,130 +14,135 @@ module.exports = {
organizationName: 'woodpecker-ci',
projectName: 'woodpecker-ci.github.io',
trailingSlash: false,
- themeConfig: {
- navbar: {
- title: 'Woodpecker',
- logo: {
- alt: 'Woodpecker Logo',
- src: 'img/logo.svg',
+ themeConfig:
+ /** @type {import('@docusaurus/preset-classic').ThemeConfig} */
+ ({
+ navbar: {
+ title: 'Woodpecker',
+ logo: {
+ alt: 'Woodpecker Logo',
+ src: 'img/logo.svg',
+ },
+ items: [
+ {
+ to: 'docs/intro',
+ activeBaseRegex: 'docs/(?!migrations|awesome)',
+ position: 'left',
+ label: 'Docs',
+ },
+ {
+ to: '/plugins',
+ position: 'left',
+ label: 'Plugins',
+ },
+ {
+ to: '/docs/migrations',
+ activeBaseRegex: 'docs/migrations',
+ position: 'left',
+ label: 'Migrations',
+ },
+ {
+ to: '/faq',
+ position: 'left',
+ label: 'FAQ',
+ },
+ {
+ to: '/docs/awesome',
+ position: 'left',
+ label: 'Awesome',
+ },
+ {
+ type: 'docsVersionDropdown',
+ position: 'right',
+ },
+ {
+ href: 'https://github.com/woodpecker-ci/woodpecker',
+ position: 'right',
+ className: 'header-github-link',
+ 'aria-label': 'GitHub repository',
+ },
+ {
+ label: '🧡 Sponsor Us',
+ position: 'right',
+ href: 'https://opencollective.com/woodpecker-ci',
+ },
+ ],
},
- items: [
- {
- to: 'docs/intro',
- activeBaseRegex: 'docs/(?!migrations|awesome)',
- position: 'left',
- label: 'Docs',
- },
- {
- to: '/plugins',
- position: 'left',
- label: 'Plugins',
- },
- {
- to: '/docs/migrations',
- activeBaseRegex: 'docs/migrations',
- position: 'left',
- label: 'Migrations',
- },
- {
- to: '/faq',
- position: 'left',
- label: 'FAQ',
- },
- {
- to: '/docs/awesome',
- position: 'left',
- label: 'Awesome',
- },
- {
- type: 'docsVersionDropdown',
- position: 'right',
- },
- {
- href: 'https://github.com/woodpecker-ci/woodpecker',
- position: 'right',
- className: 'header-github-link',
- 'aria-label': 'GitHub repository',
- },
- {
- label: '🧡 Sponsor Us',
- position: 'right',
- href: 'https://opencollective.com/woodpecker-ci',
- },
- ],
- },
- footer: {
- style: 'dark',
- links: [
- {
- title: 'Docs',
- items: [
- {
- label: 'Usage',
- to: '/docs/usage/intro',
- },
- {
- label: 'Server setup',
- to: '/docs/administration/setup',
- },
- {
- label: 'FAQ',
- to: '/faq',
- },
- ],
- },
- {
- title: 'Community',
- items: [
- {
- label: 'Discord',
- href: 'https://discord.gg/fcMQqSMXJy',
- },
- {
- label: 'Matrix',
- href: 'https://matrix.to/#/#woodpecker:matrix.org',
- },
- {
- label: 'Mastodon',
- href: 'https://mastodon.technology/@WoodpeckerCI',
- },
- ],
- },
- {
- title: 'More',
- items: [
- {
- label: 'Translate',
- href: 'https://translate.woodpecker-ci.org/engage/woodpecker-ci/',
- },
- {
- label: 'GitHub',
- href: 'https://github.com/woodpecker-ci/woodpecker',
- },
- {
- href: 'https://ci.woodpecker-ci.org/woodpecker-ci/woodpecker',
- label: 'CI',
- },
- ],
- },
- ],
- copyright: `Copyright © ${new Date().getFullYear()} Woodpecker CI. Built with Docusaurus.`,
- },
- prism: {
- theme: lightCodeTheme,
- darkTheme: darkCodeTheme,
- },
- announcementBar: {
- id: 'github-star',
- content: ` If you like Woodpecker-CI, give us a star on GitHub ! ⭐️`,
- backgroundColor: 'var(--ifm-color-primary)',
- textColor: 'var(--ifm-color-gray-900)',
- },
- tableOfContents: {
- minHeadingLevel: 2,
- maxHeadingLevel: 4,
- },
- },
+ footer: {
+ style: 'dark',
+ links: [
+ {
+ title: 'Docs',
+ items: [
+ {
+ label: 'Usage',
+ to: '/docs/usage/intro',
+ },
+ {
+ label: 'Server setup',
+ to: '/docs/administration/setup',
+ },
+ {
+ label: 'FAQ',
+ to: '/faq',
+ },
+ ],
+ },
+ {
+ title: 'Community',
+ items: [
+ {
+ label: 'Discord',
+ href: 'https://discord.gg/fcMQqSMXJy',
+ },
+ {
+ label: 'Matrix',
+ href: 'https://matrix.to/#/#woodpecker:matrix.org',
+ },
+ {
+ label: 'Mastodon',
+ href: 'https://mastodon.technology/@WoodpeckerCI',
+ },
+ ],
+ },
+ {
+ title: 'More',
+ items: [
+ {
+ label: 'Translate',
+ href: 'https://translate.woodpecker-ci.org/engage/woodpecker-ci/',
+ },
+ {
+ label: 'GitHub',
+ href: 'https://github.com/woodpecker-ci/woodpecker',
+ },
+ {
+ href: 'https://ci.woodpecker-ci.org/woodpecker-ci/woodpecker',
+ label: 'CI',
+ },
+ ],
+ },
+ ],
+ copyright: `Copyright © ${new Date().getFullYear()} Woodpecker CI. Built with Docusaurus.`,
+ },
+ prism: {
+ theme: lightCodeTheme,
+ darkTheme: darkCodeTheme,
+ },
+ announcementBar: {
+ id: 'github-star',
+ content: ` If you like Woodpecker-CI, give us a star on GitHub ! ⭐️`,
+ backgroundColor: 'var(--ifm-color-primary)',
+ textColor: 'var(--ifm-color-gray-900)',
+ },
+ tableOfContents: {
+ minHeadingLevel: 2,
+ maxHeadingLevel: 4,
+ },
+ colorMode: {
+ respectPrefersColorScheme: true,
+ },
+ }),
plugins: [
() => ({
name: 'docusaurus-plugin-favicon',
@@ -177,7 +182,8 @@ module.exports = {
presets: [
[
'@docusaurus/preset-classic',
- {
+ /** @type {import('@docusaurus/preset-classic').Options} */
+ ({
docs: {
sidebarPath: require.resolve('./sidebars.js'),
editUrl: 'https://github.com/woodpecker-ci/woodpecker/edit/master/docs/',
@@ -197,7 +203,7 @@ module.exports = {
theme: {
customCss: require.resolve('./src/css/custom.css'),
},
- },
+ }),
],
],
webpack: {