2023-11-05 09:43:44 +00:00
import { themes } from 'prism-react-renderer' ;
2023-11-05 11:47:42 +00:00
import type { Config } from '@docusaurus/types' ;
2023-11-05 09:43:44 +00:00
import type * as Preset from '@docusaurus/preset-classic' ;
import * as path from 'path' ;
2021-09-11 15:10:32 +00:00
2023-11-05 09:43:44 +00:00
const config : Config = {
2021-09-11 15:10:32 +00:00
title : 'Woodpecker CI' ,
2023-12-19 13:12:18 +00:00
tagline : 'Woodpecker is a simple yet powerful CI/CD engine with great extensibility.' ,
2021-10-14 16:13:57 +00:00
url : 'https://woodpecker-ci.org' ,
2021-09-11 15:10:32 +00:00
baseUrl : '/' ,
onBrokenLinks : 'throw' ,
2021-10-16 19:27:51 +00:00
onBrokenMarkdownLinks : 'throw' ,
2024-04-25 06:29:49 +00:00
onBrokenAnchors : 'throw' ,
2021-10-16 19:27:51 +00:00
onDuplicateRoutes : 'throw' ,
2021-09-11 15:10:32 +00:00
organizationName : 'woodpecker-ci' ,
projectName : 'woodpecker-ci.github.io' ,
trailingSlash : false ,
2023-11-05 11:47:42 +00:00
themeConfig : {
navbar : {
title : 'Woodpecker' ,
logo : {
alt : 'Woodpecker Logo' ,
src : 'img/logo.svg' ,
2022-10-08 08:53:42 +00:00
} ,
2023-11-05 11:47:42 +00:00
items : [
{
type : 'doc' ,
docId : 'intro' ,
activeBaseRegex : 'docs/(?!migrations|awesome)' ,
position : 'left' ,
label : 'Docs' ,
} ,
{
to : '/plugins' ,
position : 'left' ,
label : 'Plugins' ,
} ,
2024-06-01 06:34:17 +00:00
{ to : 'blog' , label : 'Blog' , position : 'left' } ,
2023-11-05 11:47:42 +00:00
{
2024-06-01 06:34:17 +00:00
label : 'More Resources' ,
2023-11-05 11:47:42 +00:00
position : 'left' ,
2024-06-01 06:34:17 +00:00
items : [
{
to : '/docs/next/migrations' , // Always point to newest migration guide
activeBaseRegex : 'docs/(next/)?migrations' ,
label : 'Migrations' ,
} ,
{
to : '/docs/next/awesome' , // Always point to newest awesome list
activeBaseRegex : 'docs/(next/)?awesome' ,
label : 'Awesome' ,
} ,
{
to : '/api' ,
label : 'API' ,
} ,
{ to : 'cookbook' , label : 'Cookbook' } ,
] ,
2023-11-05 11:47:42 +00:00
} ,
{
type : 'docsVersionDropdown' ,
position : 'right' ,
2024-06-04 08:14:39 +00:00
dropdownItemsAfter : [
{
to : '/versions' ,
label : 'All versions' ,
} ,
] ,
2023-11-05 11:47:42 +00:00
} ,
{
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 : 'Introduction' ,
to : '/docs/intro' ,
} ,
{
label : 'Usage' ,
to : '/docs/usage/intro' ,
} ,
{
label : 'Server setup' ,
2023-11-23 16:00:54 +00:00
to : '/docs/administration/deployment/overview' ,
2023-11-05 11:47:42 +00:00
} ,
] ,
} ,
{
title : 'Community' ,
items : [
{
label : 'Matrix' ,
href : 'https://matrix.to/#/#woodpecker:matrix.org' ,
} ,
{
label : 'Mastodon' ,
href : 'https://floss.social/@WoodpeckerCI' ,
} ,
2024-01-07 12:48:08 +00:00
{
label : 'X' ,
href : 'https://twitter.com/woodpeckerci' ,
} ,
2023-11-05 11:47:42 +00:00
] ,
} ,
{
title : 'More' ,
items : [
{
label : 'Translate' ,
href : 'https://translate.woodpecker-ci.org/engage/woodpecker-ci/' ,
} ,
{
label : 'GitHub' ,
href : 'https://github.com/woodpecker-ci/woodpecker' ,
} ,
{
2024-01-11 17:43:54 +00:00
href : 'https://ci.woodpecker-ci.org/repos/3780' ,
2023-11-05 11:47:42 +00:00
label : 'CI' ,
} ,
2024-01-26 06:41:05 +00:00
{
href : 'https://opencollective.com/woodpecker-ci' ,
label : 'Open Collective' ,
} ,
2023-11-05 11:47:42 +00:00
] ,
} ,
] ,
copyright : ` Copyright © ${ new Date ( ) . getFullYear ( ) } Woodpecker CI. Built with Docusaurus. ` ,
} ,
prism : {
theme : themes.github ,
darkTheme : themes.dracula ,
2024-01-11 17:43:54 +00:00
additionalLanguages : [
'diff' ,
'json' ,
'docker' ,
'javascript' ,
'css' ,
'bash' ,
'nginx' ,
'apacheconf' ,
'ini' ,
'nix' ,
'uri' ,
] ,
2023-11-05 11:47:42 +00:00
} ,
announcementBar : {
id : 'github-star' ,
content : ` If you like Woodpecker-CI, <a href=https://github.com/woodpecker-ci/woodpecker rel="noopener noreferrer" target="_blank">give us a star on GitHub</a> ! ⭐️ ` ,
backgroundColor : 'var(--ifm-color-primary)' ,
textColor : 'var(--ifm-color-gray-900)' ,
} ,
tableOfContents : {
minHeadingLevel : 2 ,
maxHeadingLevel : 4 ,
} ,
colorMode : {
respectPrefersColorScheme : true ,
} ,
} satisfies Preset . ThemeConfig ,
2022-04-06 15:15:28 +00:00
plugins : [
( ) = > ( {
name : 'docusaurus-plugin-favicon' ,
injectHtmlTags() {
return {
headTags : [
{
tagName : 'link' ,
attributes : {
rel : 'icon' ,
href : '/img/favicon.ico' ,
sizes : 'any' ,
} ,
} ,
{
tagName : 'link' ,
attributes : {
rel : 'icon' ,
href : '/img/favicon.svg' ,
type : 'image/svg+xml' ,
} ,
} ,
] ,
} ;
} ,
} ) ,
2022-10-19 16:05:29 +00:00
( ) = > ( {
name : 'webpack-config' ,
configureWebpack() {
return {
devServer : {
client : {
webSocketURL : 'auto://0.0.0.0:0/ws' ,
} ,
} ,
2024-06-01 06:34:17 +00:00
} as any ;
2022-10-19 16:05:29 +00:00
} ,
} ) ,
2023-12-23 11:27:36 +00:00
[
'@docusaurus/plugin-content-blog' ,
{
id : 'cookbook-blog' ,
/ * *
* URL route for the blog section of your site .
* * DO NOT * include a trailing slash .
* /
routeBasePath : 'cookbook' ,
/ * *
* Path to data on filesystem relative to site dir .
* /
path : './cookbook' ,
} ,
] ,
2022-04-06 15:15:28 +00:00
] ,
2022-08-14 07:19:24 +00:00
themes : [
path . resolve ( __dirname , 'plugins' , 'woodpecker-plugins' , 'dist' ) ,
[
2022-09-25 17:04:47 +00:00
require . resolve ( '@easyops-cn/docusaurus-search-local' ) ,
2022-08-14 07:19:24 +00:00
{
hashed : true ,
} ,
] ,
] ,
2021-09-11 15:10:32 +00:00
presets : [
[
'@docusaurus/preset-classic' ,
2023-11-05 11:47:42 +00:00
{
2021-09-11 15:10:32 +00:00
docs : {
sidebarPath : require.resolve ( './sidebars.js' ) ,
2023-07-31 03:47:23 +00:00
editUrl : 'https://github.com/woodpecker-ci/woodpecker/edit/main/docs/' ,
2022-08-31 23:52:52 +00:00
includeCurrentVersion : true ,
2024-06-01 06:34:17 +00:00
lastVersion : '2.5' ,
onlyIncludeVersions :
process . env . NODE_ENV === 'development' ? [ 'current' , '2.5' ] : [ 'current' , '2.5' , '2.4' , '2.3' , '1.0' ] ,
2022-08-31 23:52:52 +00:00
versions : {
2023-10-24 12:42:05 +00:00
current : {
2024-06-04 08:14:39 +00:00
label : 'Next 🚧' ,
2022-08-31 23:52:52 +00:00
banner : 'unreleased' ,
} ,
2024-06-01 06:34:17 +00:00
'2.5' : {
label : '2.5.x' ,
} ,
2024-03-19 07:36:20 +00:00
'2.4' : {
2024-06-04 08:14:39 +00:00
label : '2.4.x 💀' ,
2024-06-01 06:34:17 +00:00
banner : 'unmaintained' ,
2024-03-19 07:36:20 +00:00
} ,
2024-01-31 18:47:52 +00:00
'2.3' : {
2024-06-04 08:14:39 +00:00
label : '2.3.x 💀' ,
2023-12-26 18:49:12 +00:00
banner : 'unmaintained' ,
} ,
2023-07-25 10:41:58 +00:00
'1.0' : {
2024-06-04 08:14:39 +00:00
label : '1.0.x 💀' ,
2023-11-14 13:45:44 +00:00
banner : 'unmaintained' ,
2023-07-25 10:41:58 +00:00
} ,
2022-08-31 23:52:52 +00:00
} ,
2021-09-11 15:10:32 +00:00
} ,
2023-07-11 21:31:45 +00:00
blog : {
2023-08-09 13:23:13 +00:00
blogTitle : 'Blog' ,
blogDescription : 'A blog for release announcements, turorials...' ,
2023-07-11 21:31:45 +00:00
// postsPerPage: 'ALL',
// blogSidebarCount: 0,
} ,
2021-09-11 15:10:32 +00:00
theme : {
customCss : require.resolve ( './src/css/custom.css' ) ,
} ,
2023-11-05 11:47:42 +00:00
} satisfies Preset . Options ,
2021-09-11 15:10:32 +00:00
] ,
2023-06-04 03:07:39 +00:00
[
'redocusaurus' ,
{
// Plugin Options for loading OpenAPI files
specs : [
{
spec : 'swagger.json' ,
route : '/api/' ,
} ,
] ,
// Theme Options for modifying how redoc renders them
theme : {
// Change with your site colors
primaryColor : '#1890ff' ,
} ,
} ,
] ,
2021-09-11 15:10:32 +00:00
] ,
2024-03-24 12:55:12 +00:00
webpack : {
jsLoader : ( isServer ) = > ( {
loader : require.resolve ( 'esbuild-loader' ) ,
options : {
loader : 'tsx' ,
target : isServer ? 'node12' : 'es2017' ,
supported : { 'dynamic-import' : false } ,
} ,
} ) ,
} ,
2023-11-05 09:43:44 +00:00
markdown : {
2023-11-05 11:47:42 +00:00
format : 'detect' ,
} ,
2021-09-11 15:10:32 +00:00
} ;
2023-11-05 09:43:44 +00:00
export default config ;