From aa7cd4f5af8bd5147ac5dbc7b473d356dfdf572a Mon Sep 17 00:00:00 2001 From: Jim Schubert Date: Tue, 11 Feb 2020 08:22:58 -0500 Subject: [PATCH] [docs] Upgrade to Docusaurus 2 (#5271) * [docs] Upgrade to Docusaurus 2 Due to formatting issues with Docusaurus 1 and code blocks, and upcoming 4.3 and 5.0 releases, this is an upgrade to have more control over formatting and other functionality. This adds behavior to have light/dark themes. As a consequence of upgrading, columnar format on ul element in generated generator docs had to be moved to css. This will not impact users viewing the markdown on GitHub because it didn't display the column format. This upgrade should improve syntax highlighting and performance. * Fix user page layout, choose theme with clear diff colors --- docs/3.0.0-release-note.md | 4 +- docs/customization.md | 2 +- docs/faq-contributing.md | 2 +- docs/faq-extending.md | 2 +- docs/faq-generators.md | 2 +- docs/faq.md | 2 +- docs/generators/ada-server.md | 6 +- docs/generators/ada.md | 6 +- docs/generators/android.md | 8 +- docs/generators/apache2.md | 6 +- docs/generators/apex.md | 6 +- docs/generators/asciidoc.md | 6 +- docs/generators/aspnetcore.md | 6 +- docs/generators/avro-schema.md | 6 +- docs/generators/bash.md | 6 +- docs/generators/c.md | 6 +- docs/generators/clojure.md | 6 +- docs/generators/cpp-pistache-server.md | 6 +- docs/generators/cpp-qt5-client.md | 6 +- docs/generators/cpp-qt5-qhttpengine-server.md | 6 +- docs/generators/cpp-restbed-server.md | 6 +- docs/generators/cpp-restsdk.md | 6 +- docs/generators/cpp-tizen.md | 6 +- docs/generators/csharp-dotnet2.md | 6 +- docs/generators/csharp-nancyfx.md | 6 +- docs/generators/csharp-netcore.md | 8 +- docs/generators/csharp.md | 8 +- docs/generators/cwiki.md | 6 +- docs/generators/dart-dio.md | 8 +- docs/generators/dart-jaguar.md | 6 +- docs/generators/dart.md | 6 +- docs/generators/dynamic-html.md | 6 +- docs/generators/eiffel.md | 6 +- docs/generators/elixir.md | 6 +- docs/generators/elm.md | 8 +- docs/generators/erlang-client.md | 6 +- docs/generators/erlang-proper.md | 6 +- docs/generators/erlang-server.md | 6 +- docs/generators/flash.md | 6 +- docs/generators/fsharp-functions.md | 6 +- docs/generators/fsharp-giraffe-server.md | 6 +- docs/generators/go-experimental.md | 6 +- docs/generators/go-gin-server.md | 6 +- docs/generators/go-server.md | 6 +- docs/generators/go.md | 6 +- .../graphql-nodejs-express-server.md | 6 +- docs/generators/graphql-schema.md | 6 +- docs/generators/groovy.md | 12 +- docs/generators/haskell-http-client.md | 6 +- docs/generators/haskell.md | 6 +- docs/generators/html.md | 6 +- docs/generators/html2.md | 6 +- docs/generators/java-inflector.md | 12 +- docs/generators/java-msf4j.md | 14 +- docs/generators/java-pkmst.md | 12 +- docs/generators/java-play-framework.md | 12 +- docs/generators/java-undertow-server.md | 12 +- docs/generators/java-vertx-web.md | 12 +- docs/generators/java-vertx.md | 12 +- docs/generators/java.md | 16 +- docs/generators/javascript-closure-angular.md | 6 +- docs/generators/javascript-flowtyped.md | 6 +- docs/generators/javascript.md | 6 +- docs/generators/jaxrs-cxf-cdi.md | 14 +- docs/generators/jaxrs-cxf-client.md | 12 +- docs/generators/jaxrs-cxf-extended.md | 12 +- docs/generators/jaxrs-cxf.md | 12 +- docs/generators/jaxrs-jersey.md | 14 +- docs/generators/jaxrs-resteasy-eap.md | 12 +- docs/generators/jaxrs-resteasy.md | 12 +- docs/generators/jaxrs-spec.md | 14 +- docs/generators/jmeter.md | 6 +- docs/generators/kotlin-server.md | 8 +- docs/generators/kotlin-spring.md | 8 +- docs/generators/kotlin-vertx.md | 6 +- docs/generators/kotlin.md | 14 +- docs/generators/lua.md | 6 +- docs/generators/markdown.md | 6 +- docs/generators/mysql-schema.md | 8 +- docs/generators/nim.md | 6 +- docs/generators/nodejs-express-server.md | 6 +- docs/generators/nodejs-server-deprecated.md | 6 +- docs/generators/objc.md | 6 +- docs/generators/ocaml.md | 6 +- docs/generators/openapi-yaml.md | 6 +- docs/generators/openapi.md | 6 +- docs/generators/perl.md | 6 +- docs/generators/php-laravel.md | 6 +- docs/generators/php-lumen.md | 6 +- docs/generators/php-silex.md | 6 +- docs/generators/php-slim-deprecated.md | 6 +- docs/generators/php-slim4.md | 8 +- docs/generators/php-symfony.md | 6 +- docs/generators/php-ze-ph.md | 6 +- docs/generators/php.md | 6 +- docs/generators/powershell.md | 6 +- docs/generators/protobuf-schema.md | 6 +- docs/generators/python-aiohttp.md | 6 +- docs/generators/python-blueplanet.md | 6 +- docs/generators/python-experimental.md | 6 +- docs/generators/python-flask.md | 6 +- docs/generators/python.md | 6 +- docs/generators/r.md | 8 +- docs/generators/ruby-on-rails.md | 6 +- docs/generators/ruby-sinatra.md | 6 +- docs/generators/ruby.md | 8 +- docs/generators/rust-server.md | 6 +- docs/generators/rust.md | 8 +- docs/generators/scala-akka.md | 6 +- docs/generators/scala-finch.md | 6 +- docs/generators/scala-gatling.md | 6 +- .../generators/scala-httpclient-deprecated.md | 6 +- docs/generators/scala-lagom-server.md | 6 +- docs/generators/scala-play-server.md | 6 +- docs/generators/scalatra.md | 6 +- docs/generators/scalaz.md | 6 +- docs/generators/spring.md | 14 +- docs/generators/swift2-deprecated.md | 6 +- docs/generators/swift3-deprecated.md | 6 +- docs/generators/swift4.md | 6 +- docs/generators/swift5.md | 8 +- docs/generators/typescript-angular.md | 6 +- docs/generators/typescript-angularjs.md | 6 +- docs/generators/typescript-aurelia.md | 6 +- docs/generators/typescript-axios.md | 6 +- docs/generators/typescript-fetch.md | 6 +- docs/generators/typescript-inversify.md | 6 +- docs/generators/typescript-jquery.md | 6 +- docs/generators/typescript-node.md | 6 +- docs/generators/typescript-redux-query.md | 6 +- docs/generators/typescript-rxjs.md | 6 +- docs/installation.md | 2 +- docs/qna.md | 2 +- docs/templating.md | 7 +- docs/usage.md | 7 +- .../openapitools/codegen/cmd/ConfigHelp.java | 6 +- website/.gitignore | 16 + website/core/EditThisPage.js | 40 - website/core/Footer.js | 88 - website/docusaurus.config.js | 186 + website/package.json | 41 +- website/pages/en/help.js | 54 - website/pages/en/index.js | 400 - website/pages/en/team.js | 97 - website/pages/en/users.js | 52 - website/sidebars.js | 47 + website/sidebars.json | 43 - website/siteConfig.js | 120 - website/src/css/custom.css | 141 + website/{ => src}/dynamic/sponsors.yml | 0 website/{ => src}/dynamic/team.yml | 0 website/{ => src}/dynamic/users.yml | 0 website/src/pages/index.js | 405 + website/src/pages/styles.module.css | 128 + website/src/pages/team.js | 96 + website/src/pages/users.js | 54 + website/static/CNAME | 1 + website/static/css/custom.css | 90 - website/yarn.lock | 7284 ++++++++++++----- 159 files changed, 6717 insertions(+), 3610 deletions(-) create mode 100644 website/.gitignore delete mode 100644 website/core/EditThisPage.js delete mode 100755 website/core/Footer.js create mode 100755 website/docusaurus.config.js delete mode 100755 website/pages/en/help.js delete mode 100755 website/pages/en/index.js delete mode 100644 website/pages/en/team.js delete mode 100755 website/pages/en/users.js create mode 100755 website/sidebars.js delete mode 100755 website/sidebars.json delete mode 100755 website/siteConfig.js create mode 100755 website/src/css/custom.css rename website/{ => src}/dynamic/sponsors.yml (100%) rename website/{ => src}/dynamic/team.yml (100%) rename website/{ => src}/dynamic/users.yml (100%) create mode 100755 website/src/pages/index.js create mode 100644 website/src/pages/styles.module.css create mode 100644 website/src/pages/team.js create mode 100755 website/src/pages/users.js create mode 100644 website/static/CNAME delete mode 100755 website/static/css/custom.css diff --git a/docs/3.0.0-release-note.md b/docs/3.0.0-release-note.md index 4929c3ae1ef..6bfaaaffaa4 100644 --- a/docs/3.0.0-release-note.md +++ b/docs/3.0.0-release-note.md @@ -1,7 +1,7 @@ --- id: release-3-0-0 -title: Release Notes: 3.0.0 -sidebar_label: Release Notes: 3.0.0 +title: "Release Notes: 3.0.0" +sidebar_label: "Release Notes: 3.0.0" --- * ## Docker diff --git a/docs/customization.md b/docs/customization.md index 807b2fdb336..4b5b8ed7fa3 100644 --- a/docs/customization.md +++ b/docs/customization.md @@ -3,7 +3,7 @@ id: customization title: Customization --- - + ## Custom Generator (and Template) If none of the built-in generators suit your needs and you need to do more than just modify the mustache templates to tweak generated code, you can create a brand new generator and its associated templates. OpenAPI Generator can help with this, using the `meta` command: diff --git a/docs/faq-contributing.md b/docs/faq-contributing.md index 19fe39ee0e8..4652194e9d7 100644 --- a/docs/faq-contributing.md +++ b/docs/faq-contributing.md @@ -1,6 +1,6 @@ --- id: faq-contributing -title: FAQ: Contributing +title: "FAQ: Contributing" --- ## Automated checks on my PR have failed. Do you know what's wrong? diff --git a/docs/faq-extending.md b/docs/faq-extending.md index d75469f94bc..530134caea7 100644 --- a/docs/faq-extending.md +++ b/docs/faq-extending.md @@ -1,6 +1,6 @@ --- id: faq-extending -title: FAQ: Extending +title: "FAQ: Extending" --- ## How do I use my own Java models? diff --git a/docs/faq-generators.md b/docs/faq-generators.md index 66fd5b08967..d8d3162c496 100644 --- a/docs/faq-generators.md +++ b/docs/faq-generators.md @@ -1,6 +1,6 @@ --- id: faq-generators -title: FAQ: Generators +title: "FAQ: Generators" --- ### What are some server generator use cases? diff --git a/docs/faq.md b/docs/faq.md index 7ccb70bdf9e..69749ae3eda 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -1,6 +1,6 @@ --- id: faq -title: FAQ: General +title: "FAQ: General" --- ## Do you have a chat room? diff --git a/docs/generators/ada-server.md b/docs/generators/ada-server.md index d87f699e24c..9a86032ec7e 100644 --- a/docs/generators/ada-server.md +++ b/docs/generators/ada-server.md @@ -26,7 +26,8 @@ sidebar_label: ada-server ## LANGUAGE PRIMITIVES -