2020-02-11 08:22:58 -05:00
const fs = require ( 'fs' ) ;
const path = require ( 'path' ) ;
2025-11-19 16:53:26 +08:00
const parseYaml = require ( "js-yaml" ) . load ;
2020-02-11 08:22:58 -05:00
const loadYaml = relativePath => parseYaml ( fs . readFileSync ( path . join ( _ _dirname , relativePath ) , "utf8" ) ) ;
// See https://docusaurus.io/docs/site-config for all the possible
// site configuration options.
const team = loadYaml ( "src/dynamic/team.yml" ) ;
const users = loadYaml ( "src/dynamic/users.yml" ) ;
const sponsors = loadYaml ( "src/dynamic/sponsors.yml" ) ;
const baseUrl = '/' ;
const docusaurusConfig = {
title : 'OpenAPI Generator' ,
tagline : 'Generate clients, servers, and documentation from OpenAPI 2.0/3.x documents' ,
url : 'https://openapi-generator.tech' , // Your website URL
baseUrl : baseUrl , // Base URL for your project */
favicon : 'img/favicon.png' ,
organizationName : 'OpenAPITools' ,
projectName : 'openapi-generator' ,
2023-02-17 16:53:07 +08:00
onBrokenLinks : 'ignore' ,
2020-02-11 08:22:58 -05:00
// // You may provide arbitrary config keys to be used as needed by your
// // template. For example, if you need your repo's URL...
// repoUrl: 'https://github.com/OpenAPITools/openapi-generator',
2023-02-17 14:15:29 +08:00
//plugins: ['@docusaurus/plugin-google-analytics'],
2020-02-11 08:22:58 -05:00
themeConfig : {
// Open Graph and Twitter card images.
image : 'img/docusaurus.png' ,
prism : {
theme : require ( 'prism-react-renderer/themes/dracula' ) ,
defaultLanguage : 'bash' ,
} ,
navbar : {
title : 'OpenAPI Generator' ,
logo : {
src : 'img/mono-logo.svg' ,
alt : 'OpenAPI Tools logo' ,
} ,
2023-02-17 14:15:29 +08:00
items : [
2020-05-31 07:14:31 -04:00
{ to : 'docs/installation' , label : 'Getting Started' } ,
2020-02-11 08:22:58 -05:00
{ to : 'docs/generators' , label : 'Generators' } ,
{ to : 'docs/roadmap' , label : 'Roadmap' } ,
{ to : "docs/faq" , label : "FAQ" } ,
{ to : "team" , label : "Team" } ,
{ to : "blog" , label : 'Blog' } ,
2020-02-17 01:03:25 -05:00
{ to : 'https://api.openapi-generator.tech' , label : 'API' } ,
2020-02-11 08:22:58 -05:00
] ,
} ,
2020-02-27 22:33:40 -05:00
algolia : {
2023-11-14 14:18:55 +08:00
appId : '51ITDG8FYN' ,
apiKey : '68eb9329427345f267486fd4f2d67b89' ,
2020-02-27 22:33:40 -05:00
indexName : 'openapi-generator' ,
} ,
2020-02-11 08:22:58 -05:00
footer : {
style : 'dark' ,
logo : {
alt : 'OpenAPI Tools' ,
src : 'img/mono-logo.svg' ,
href : 'https://openapi-generator.tech/' ,
} ,
copyright : ` Copyright © ${ new Date ( ) . getFullYear ( ) } OpenAPI-Generator Contributors (https://openapi-generator.tech) ` ,
links : [
{
title : 'Docs' ,
items : [
{
label : 'Customizing Generators' ,
to : 'docs/customization' ,
} ,
{
label : 'Installation' ,
to : 'docs/installation' ,
} ,
{
label : 'Workflow Integrations' ,
to : 'docs/integrations' ,
} ,
] ,
} ,
{
title : 'Community' ,
items : [
{
label : 'User Showcase' ,
to : 'users' ,
} ,
{
label : 'Stack Overflow' ,
href : 'https://stackoverflow.com/questions/tagged/openapi-generator' ,
} ,
{
label : 'Chat Room' ,
2025-06-03 09:26:46 +02:00
href : 'https://join.slack.com/t/openapi-generator/shared_invite/zt-36ucx4ybl-jYrN6euoYn6zxXNZdldoZA' ,
2020-02-11 08:22:58 -05:00
} ,
{
label : 'Twitter' ,
href : 'https://twitter.com/oas_generator' ,
} ,
] ,
} ,
{
title : 'More' ,
items : [
{
label : 'Blog' ,
to : 'blog' ,
} ,
{
label : 'GitHub' ,
href : 'https://github.com/OpenAPITools/openapi-generator' ,
} ,
] ,
} ,
]
} ,
} ,
presets : [
[
'@docusaurus/preset-classic' ,
{
theme : {
customCss : require . resolve ( './src/css/custom.css' ) ,
} ,
docs : {
// docs folder path relative to website dir.
path : '../docs' ,
include : [ '**/*.md' , '**/*.mdx' ] ,
// sidebars file relative to website dir.
sidebarPath : require . resolve ( './sidebars.js' ) ,
/**
* Theme components used by the docs pages
*/
docLayoutComponent : '@theme/DocPage' ,
docItemComponent : '@theme/DocItem' ,
2023-02-17 14:15:29 +08:00
sidebarCollapsible : true ,
2020-02-11 08:22:58 -05:00
editUrl : 'https://github.com/OpenAPITools/openapi-generator/edit/master/website' ,
// Equivalent to `docsUrl`.
routeBasePath : 'docs' ,
// Remark and Rehype plugins passed to MDX. Replaces `markdownOptions` and `markdownPlugins`.
remarkPlugins : [ ] ,
rehypePlugins : [ ] ,
// Equivalent to `enableUpdateBy`.
showLastUpdateAuthor : true ,
// Equivalent to `enableUpdateTime`.
showLastUpdateTime : true ,
} ,
2023-02-17 14:15:29 +08:00
googleAnalytics : {
trackingID : 'UA-132927057-1' ,
} ,
2020-02-11 08:22:58 -05:00
} ,
] ,
] ,
// Add custom scripts here that would be placed in <script> tags.
scripts : [
'https://buttons.github.io/buttons.js' ,
'https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js' ,
` ${ baseUrl } js/code-block-buttons.js ` ,
] ,
customFields : {
users : users ,
sponsors : sponsors ,
team : team
} ,
} ;
module . exports = docusaurusConfig ;
