Skip to content

Commit aa7cd4f

Browse files
authored
[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
1 parent 49c4b63 commit aa7cd4f

159 files changed

Lines changed: 6755 additions & 3648 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

docs/3.0.0-release-note.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
id: release-3-0-0
3-
title: Release Notes: 3.0.0
4-
sidebar_label: Release Notes: 3.0.0
3+
title: "Release Notes: 3.0.0"
4+
sidebar_label: "Release Notes: 3.0.0"
55
---
66

77
* ## Docker

docs/customization.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ id: customization
33
title: Customization
44
---
55

6-
<a id="creating-a-new-template"></a><!-- maintain old link ref name.-->
6+
<a id="creating-a-new-template"></a>
77
## Custom Generator (and Template)
88

99
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:

docs/faq-contributing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
id: faq-contributing
3-
title: FAQ: Contributing
3+
title: "FAQ: Contributing"
44
---
55

66
## Automated checks on my PR have failed. Do you know what's wrong?

docs/faq-extending.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
id: faq-extending
3-
title: FAQ: Extending
3+
title: "FAQ: Extending"
44
---
55

66
## How do I use my own Java models?

docs/faq-generators.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
id: faq-generators
3-
title: FAQ: Generators
3+
title: "FAQ: Generators"
44
---
55

66
### What are some server generator use cases?

docs/faq.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
id: faq
3-
title: FAQ: General
3+
title: "FAQ: General"
44
---
55

66
## Do you have a chat room?

docs/generators/ada-server.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,8 @@ sidebar_label: ada-server
2626

2727
## LANGUAGE PRIMITIVES
2828

29-
<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>
29+
<ul class="column-ul">
30+
<li>Boolean</li>
3031
<li>Character</li>
3132
<li>Integer</li>
3233
<li>boolean</li>
@@ -38,7 +39,8 @@ sidebar_label: ada-server
3839

3940
## RESERVED WORDS
4041

41-
<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>
42+
<ul class="column-ul">
43+
<li>abort</li>
4244
<li>abs</li>
4345
<li>abstract</li>
4446
<li>accept</li>

docs/generators/ada.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,8 @@ sidebar_label: ada
2626

2727
## LANGUAGE PRIMITIVES
2828

29-
<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>
29+
<ul class="column-ul">
30+
<li>Boolean</li>
3031
<li>Character</li>
3132
<li>Integer</li>
3233
<li>boolean</li>
@@ -38,7 +39,8 @@ sidebar_label: ada
3839

3940
## RESERVED WORDS
4041

41-
<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>
42+
<ul class="column-ul">
43+
<li>abort</li>
4244
<li>abs</li>
4345
<li>abstract</li>
4446
<li>accept</li>

docs/generators/android.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ sidebar_label: android
1515
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
1616
|groupId|groupId for use in the generated build.gradle and pom.xml| |null|
1717
|invokerPackage|root package for generated code| |null|
18-
|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|
18+
|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|
1919
|modelPackage|package for generated models| |null|
2020
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
2121
|serializableModel|boolean - toggle &quot;implements Serializable&quot; for generated models| |false|
@@ -56,7 +56,8 @@ sidebar_label: android
5656

5757
## LANGUAGE PRIMITIVES
5858

59-
<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>
59+
<ul class="column-ul">
60+
<li>Boolean</li>
6061
<li>Double</li>
6162
<li>Float</li>
6263
<li>Integer</li>
@@ -69,7 +70,8 @@ sidebar_label: android
6970

7071
## RESERVED WORDS
7172

72-
<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>
73+
<ul class="column-ul">
74+
<li>abstract</li>
7375
<li>apiinvoker</li>
7476
<li>assert</li>
7577
<li>authnames</li>

docs/generators/apache2.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,11 +42,13 @@ sidebar_label: apache2
4242

4343
## LANGUAGE PRIMITIVES
4444

45-
<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>
45+
<ul class="column-ul">
46+
</ul>
4647

4748
## RESERVED WORDS
4849

49-
<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>
50+
<ul class="column-ul">
51+
</ul>
5052

5153
## FEATURE SET
5254

0 commit comments

Comments
 (0)