Skip to content

Commit

Permalink
[docs] Upgrade to Docusaurus 2 (OpenAPITools#5271)
Browse files Browse the repository at this point in the history
* [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
  • Loading branch information
jimschubert authored Feb 11, 2020
1 parent 49c4b63 commit aa7cd4f
Show file tree
Hide file tree
Showing 159 changed files with 6,755 additions and 3,648 deletions.
4 changes: 2 additions & 2 deletions docs/3.0.0-release-note.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/customization.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ id: customization
title: Customization
---

<a id="creating-a-new-template"></a><!-- maintain old link ref name.-->
<a id="creating-a-new-template"></a>
## 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:
Expand Down
2 changes: 1 addition & 1 deletion docs/faq-contributing.md
Original file line number Diff line number Diff line change
@@ -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?
Expand Down
2 changes: 1 addition & 1 deletion docs/faq-extending.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: faq-extending
title: FAQ: Extending
title: "FAQ: Extending"
---

## How do I use my own Java models?
Expand Down
2 changes: 1 addition & 1 deletion docs/faq-generators.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: faq-generators
title: FAQ: Generators
title: "FAQ: Generators"
---

### What are some server generator use cases?
Expand Down
2 changes: 1 addition & 1 deletion docs/faq.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: faq
title: FAQ: General
title: "FAQ: General"
---

## Do you have a chat room?
Expand Down
6 changes: 4 additions & 2 deletions docs/generators/ada-server.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,8 @@ sidebar_label: ada-server

## LANGUAGE PRIMITIVES

<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"><li>Boolean</li>
<ul class="column-ul">
<li>Boolean</li>
<li>Character</li>
<li>Integer</li>
<li>boolean</li>
Expand All @@ -38,7 +39,8 @@ sidebar_label: ada-server

## RESERVED WORDS

<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"><li>abort</li>
<ul class="column-ul">
<li>abort</li>
<li>abs</li>
<li>abstract</li>
<li>accept</li>
Expand Down
6 changes: 4 additions & 2 deletions docs/generators/ada.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,8 @@ sidebar_label: ada

## LANGUAGE PRIMITIVES

<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"><li>Boolean</li>
<ul class="column-ul">
<li>Boolean</li>
<li>Character</li>
<li>Integer</li>
<li>boolean</li>
Expand All @@ -38,7 +39,8 @@ sidebar_label: ada

## RESERVED WORDS

<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"><li>abort</li>
<ul class="column-ul">
<li>abort</li>
<li>abs</li>
<li>abstract</li>
<li>accept</li>
Expand Down
8 changes: 5 additions & 3 deletions docs/generators/android.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ sidebar_label: android
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|groupId|groupId for use in the generated build.gradle and pom.xml| |null|
|invokerPackage|root package for generated code| |null|
|library|library template (sub-template) to use|<dl><dt>**volley**</dt><dd>HTTP client: Volley 1.0.19 (default)</dd><dt>**httpclient**</dt><dd>HTTP client: Apache HttpClient 4.3.6. JSON processing: Gson 2.3.1. IMPORTANT: Android client using HttpClient is not actively maintained and will be depecreated in the next major release.</dd><dl>|null|
|library|library template (sub-template) to use|<dl><dt>**volley**</dt><dd>HTTP client: Volley 1.0.19 (default)</dd><dt>**httpclient**</dt><dd>HTTP client: Apache HttpClient 4.3.6. JSON processing: Gson 2.3.1. IMPORTANT: Android client using HttpClient is not actively maintained and will be depecreated in the next major release.</dd></dl>|null|
|modelPackage|package for generated models| |null|
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
|serializableModel|boolean - toggle &quot;implements Serializable&quot; for generated models| |false|
Expand Down Expand Up @@ -56,7 +56,8 @@ sidebar_label: android

## LANGUAGE PRIMITIVES

<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"><li>Boolean</li>
<ul class="column-ul">
<li>Boolean</li>
<li>Double</li>
<li>Float</li>
<li>Integer</li>
Expand All @@ -69,7 +70,8 @@ sidebar_label: android

## RESERVED WORDS

<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"><li>abstract</li>
<ul class="column-ul">
<li>abstract</li>
<li>apiinvoker</li>
<li>assert</li>
<li>authnames</li>
Expand Down
6 changes: 4 additions & 2 deletions docs/generators/apache2.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,11 +42,13 @@ sidebar_label: apache2

## LANGUAGE PRIMITIVES

<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"></ul>
<ul class="column-ul">
</ul>

## RESERVED WORDS

<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"></ul>
<ul class="column-ul">
</ul>

## FEATURE SET

Expand Down
6 changes: 4 additions & 2 deletions docs/generators/apex.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,8 @@ sidebar_label: apex

## LANGUAGE PRIMITIVES

<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"><li>Blob</li>
<ul class="column-ul">
<li>Blob</li>
<li>Boolean</li>
<li>Date</li>
<li>Datetime</li>
Expand All @@ -47,7 +48,8 @@ sidebar_label: apex

## RESERVED WORDS

<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"><li>abstract</li>
<ul class="column-ul">
<li>abstract</li>
<li>activate</li>
<li>and</li>
<li>any</li>
Expand Down
6 changes: 4 additions & 2 deletions docs/generators/asciidoc.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,11 +38,13 @@ sidebar_label: asciidoc

## LANGUAGE PRIMITIVES

<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"></ul>
<ul class="column-ul">
</ul>

## RESERVED WORDS

<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"></ul>
<ul class="column-ul">
</ul>

## FEATURE SET

Expand Down
6 changes: 4 additions & 2 deletions docs/generators/aspnetcore.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,8 @@ sidebar_label: aspnetcore

## LANGUAGE PRIMITIVES

<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"><li>Boolean</li>
<ul class="column-ul">
<li>Boolean</li>
<li>Collection</li>
<li>DateTime</li>
<li>DateTime?</li>
Expand Down Expand Up @@ -90,7 +91,8 @@ sidebar_label: aspnetcore

## RESERVED WORDS

<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"><li>Client</li>
<ul class="column-ul">
<li>Client</li>
<li>abstract</li>
<li>as</li>
<li>async</li>
Expand Down
6 changes: 4 additions & 2 deletions docs/generators/avro-schema.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,8 @@ sidebar_label: avro-schema

## LANGUAGE PRIMITIVES

<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"><li>BigDecimal</li>
<ul class="column-ul">
<li>BigDecimal</li>
<li>DateTime</li>
<li>UUID</li>
<li>boolean</li>
Expand All @@ -47,7 +48,8 @@ sidebar_label: avro-schema

## RESERVED WORDS

<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"></ul>
<ul class="column-ul">
</ul>

## FEATURE SET

Expand Down
6 changes: 4 additions & 2 deletions docs/generators/bash.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,8 @@ sidebar_label: bash

## LANGUAGE PRIMITIVES

<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"><li>array</li>
<ul class="column-ul">
<li>array</li>
<li>binary</li>
<li>boolean</li>
<li>float</li>
Expand All @@ -60,7 +61,8 @@ sidebar_label: bash

## RESERVED WORDS

<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"><li>case</li>
<ul class="column-ul">
<li>case</li>
<li>do</li>
<li>done</li>
<li>elif</li>
Expand Down
6 changes: 4 additions & 2 deletions docs/generators/c.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,8 @@ sidebar_label: c

## LANGUAGE PRIMITIVES

<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"><li>Object</li>
<ul class="column-ul">
<li>Object</li>
<li>binary_t*</li>
<li>char</li>
<li>double</li>
Expand All @@ -40,7 +41,8 @@ sidebar_label: c

## RESERVED WORDS

<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"><li>_alignas</li>
<ul class="column-ul">
<li>_alignas</li>
<li>_alignof</li>
<li>_atomic</li>
<li>_bool</li>
Expand Down
6 changes: 4 additions & 2 deletions docs/generators/clojure.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,11 +48,13 @@ sidebar_label: clojure

## LANGUAGE PRIMITIVES

<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"></ul>
<ul class="column-ul">
</ul>

## RESERVED WORDS

<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"></ul>
<ul class="column-ul">
</ul>

## FEATURE SET

Expand Down
6 changes: 4 additions & 2 deletions docs/generators/cpp-pistache-server.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,8 @@ sidebar_label: cpp-pistache-server

## LANGUAGE PRIMITIVES

<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"><li>bool</li>
<ul class="column-ul">
<li>bool</li>
<li>char</li>
<li>double</li>
<li>float</li>
Expand All @@ -39,7 +40,8 @@ sidebar_label: cpp-pistache-server

## RESERVED WORDS

<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"></ul>
<ul class="column-ul">
</ul>

## FEATURE SET

Expand Down
6 changes: 4 additions & 2 deletions docs/generators/cpp-qt5-client.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,8 @@ sidebar_label: cpp-qt5-client

## LANGUAGE PRIMITIVES

<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"><li>QByteArray</li>
<ul class="column-ul">
<li>QByteArray</li>
<li>QDate</li>
<li>QDateTime</li>
<li>QString</li>
Expand All @@ -43,7 +44,8 @@ sidebar_label: cpp-qt5-client

## RESERVED WORDS

<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"><li>alignas</li>
<ul class="column-ul">
<li>alignas</li>
<li>alignof</li>
<li>and</li>
<li>and_eq</li>
Expand Down
6 changes: 4 additions & 2 deletions docs/generators/cpp-qt5-qhttpengine-server.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,8 @@ sidebar_label: cpp-qt5-qhttpengine-server

## LANGUAGE PRIMITIVES

<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"><li>QByteArray</li>
<ul class="column-ul">
<li>QByteArray</li>
<li>QDate</li>
<li>QDateTime</li>
<li>QString</li>
Expand All @@ -42,7 +43,8 @@ sidebar_label: cpp-qt5-qhttpengine-server

## RESERVED WORDS

<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"><li>alignas</li>
<ul class="column-ul">
<li>alignas</li>
<li>alignof</li>
<li>and</li>
<li>and_eq</li>
Expand Down
6 changes: 4 additions & 2 deletions docs/generators/cpp-restbed-server.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,8 @@ sidebar_label: cpp-restbed-server

## LANGUAGE PRIMITIVES

<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"><li>bool</li>
<ul class="column-ul">
<li>bool</li>
<li>char</li>
<li>double</li>
<li>float</li>
Expand All @@ -42,7 +43,8 @@ sidebar_label: cpp-restbed-server

## RESERVED WORDS

<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"><li>alignas</li>
<ul class="column-ul">
<li>alignas</li>
<li>alignof</li>
<li>and</li>
<li>and_eq</li>
Expand Down
6 changes: 4 additions & 2 deletions docs/generators/cpp-restsdk.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,8 @@ sidebar_label: cpp-restsdk

## LANGUAGE PRIMITIVES

<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"><li>bool</li>
<ul class="column-ul">
<li>bool</li>
<li>char</li>
<li>double</li>
<li>float</li>
Expand All @@ -45,7 +46,8 @@ sidebar_label: cpp-restsdk

## RESERVED WORDS

<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"><li>alignas</li>
<ul class="column-ul">
<li>alignas</li>
<li>alignof</li>
<li>and</li>
<li>and_eq</li>
Expand Down
6 changes: 4 additions & 2 deletions docs/generators/cpp-tizen.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,8 @@ sidebar_label: cpp-tizen

## LANGUAGE PRIMITIVES

<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"><li>bool</li>
<ul class="column-ul">
<li>bool</li>
<li>double</li>
<li>float</li>
<li>int</li>
Expand All @@ -35,7 +36,8 @@ sidebar_label: cpp-tizen

## RESERVED WORDS

<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"><li>alignas</li>
<ul class="column-ul">
<li>alignas</li>
<li>alignof</li>
<li>and</li>
<li>and_eq</li>
Expand Down
Loading

0 comments on commit aa7cd4f

Please sign in to comment.