Skip to content

Commit aa7cd4f

Browse files
jimschubertjimschubert
authored
[docs] Upgrade to Docusaurus 2 (OpenAPITools#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

File tree

159 files changed

+6755
-3648
lines changed

Some content is hidden

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

159 files changed

+6755
-3648
lines changed

Diff for: ‎docs/3.0.0-release-note.md

+2-2
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

Diff for: ‎docs/customization.md

+1-1
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:

Diff for: ‎docs/faq-contributing.md

+1-1
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?

Diff for: ‎docs/faq-extending.md

+1-1
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?

Diff for: ‎docs/faq-generators.md

+1-1
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?

Diff for: ‎docs/faq.md

+1-1
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?

Diff for: ‎docs/generators/ada-server.md

+4-2
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>

Diff for: ‎docs/generators/ada.md

+4-2
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>

Diff for: ‎docs/generators/android.md

+5-3
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>

Diff for: ‎docs/generators/apache2.md

+4-2
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

Diff for: ‎docs/generators/apex.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,8 @@ sidebar_label: apex
3131

3232
## LANGUAGE PRIMITIVES
3333

34-
<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>
34+
<ul class="column-ul">
35+
<li>Blob</li>
3536
<li>Boolean</li>
3637
<li>Date</li>
3738
<li>Datetime</li>
@@ -47,7 +48,8 @@ sidebar_label: apex
4748

4849
## RESERVED WORDS
4950

50-
<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>
51+
<ul class="column-ul">
52+
<li>abstract</li>
5153
<li>activate</li>
5254
<li>and</li>
5355
<li>any</li>

Diff for: ‎docs/generators/asciidoc.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -38,11 +38,13 @@ sidebar_label: asciidoc
3838

3939
## LANGUAGE PRIMITIVES
4040

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"></ul>
41+
<ul class="column-ul">
42+
</ul>
4243

4344
## RESERVED WORDS
4445

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

4749
## FEATURE SET
4850

Diff for: ‎docs/generators/aspnetcore.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,8 @@ sidebar_label: aspnetcore
5454

5555
## LANGUAGE PRIMITIVES
5656

57-
<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>
57+
<ul class="column-ul">
58+
<li>Boolean</li>
5859
<li>Collection</li>
5960
<li>DateTime</li>
6061
<li>DateTime?</li>
@@ -90,7 +91,8 @@ sidebar_label: aspnetcore
9091

9192
## RESERVED WORDS
9293

93-
<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>
94+
<ul class="column-ul">
95+
<li>Client</li>
9496
<li>abstract</li>
9597
<li>as</li>
9698
<li>async</li>

Diff for: ‎docs/generators/avro-schema.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,8 @@ sidebar_label: avro-schema
2929

3030
## LANGUAGE PRIMITIVES
3131

32-
<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>
32+
<ul class="column-ul">
33+
<li>BigDecimal</li>
3334
<li>DateTime</li>
3435
<li>UUID</li>
3536
<li>boolean</li>
@@ -47,7 +48,8 @@ sidebar_label: avro-schema
4748

4849
## RESERVED WORDS
4950

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

5254
## FEATURE SET
5355

Diff for: ‎docs/generators/bash.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,8 @@ sidebar_label: bash
4949

5050
## LANGUAGE PRIMITIVES
5151

52-
<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>
52+
<ul class="column-ul">
53+
<li>array</li>
5354
<li>binary</li>
5455
<li>boolean</li>
5556
<li>float</li>
@@ -60,7 +61,8 @@ sidebar_label: bash
6061

6162
## RESERVED WORDS
6263

63-
<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>
64+
<ul class="column-ul">
65+
<li>case</li>
6466
<li>do</li>
6567
<li>done</li>
6668
<li>elif</li>

Diff for: ‎docs/generators/c.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,8 @@ sidebar_label: c
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>Object</li>
29+
<ul class="column-ul">
30+
<li>Object</li>
3031
<li>binary_t*</li>
3132
<li>char</li>
3233
<li>double</li>
@@ -40,7 +41,8 @@ sidebar_label: c
4041

4142
## RESERVED WORDS
4243

43-
<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>
44+
<ul class="column-ul">
45+
<li>_alignas</li>
4446
<li>_alignof</li>
4547
<li>_atomic</li>
4648
<li>_bool</li>

Diff for: ‎docs/generators/clojure.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -48,11 +48,13 @@ sidebar_label: clojure
4848

4949
## LANGUAGE PRIMITIVES
5050

51-
<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>
51+
<ul class="column-ul">
52+
</ul>
5253

5354
## RESERVED WORDS
5455

55-
<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>
56+
<ul class="column-ul">
57+
</ul>
5658

5759
## FEATURE SET
5860

Diff for: ‎docs/generators/cpp-pistache-server.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,8 @@ sidebar_label: cpp-pistache-server
2727

2828
## LANGUAGE PRIMITIVES
2929

30-
<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>
30+
<ul class="column-ul">
31+
<li>bool</li>
3132
<li>char</li>
3233
<li>double</li>
3334
<li>float</li>
@@ -39,7 +40,8 @@ sidebar_label: cpp-pistache-server
3940

4041
## RESERVED WORDS
4142

42-
<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>
43+
<ul class="column-ul">
44+
</ul>
4345

4446
## FEATURE SET
4547

Diff for: ‎docs/generators/cpp-qt5-client.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,8 @@ sidebar_label: cpp-qt5-client
3030

3131
## LANGUAGE PRIMITIVES
3232

33-
<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>
33+
<ul class="column-ul">
34+
<li>QByteArray</li>
3435
<li>QDate</li>
3536
<li>QDateTime</li>
3637
<li>QString</li>
@@ -43,7 +44,8 @@ sidebar_label: cpp-qt5-client
4344

4445
## RESERVED WORDS
4546

46-
<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>
47+
<ul class="column-ul">
48+
<li>alignas</li>
4749
<li>alignof</li>
4850
<li>and</li>
4951
<li>and_eq</li>

Diff for: ‎docs/generators/cpp-qt5-qhttpengine-server.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,8 @@ sidebar_label: cpp-qt5-qhttpengine-server
2929

3030
## LANGUAGE PRIMITIVES
3131

32-
<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>
32+
<ul class="column-ul">
33+
<li>QByteArray</li>
3334
<li>QDate</li>
3435
<li>QDateTime</li>
3536
<li>QString</li>
@@ -42,7 +43,8 @@ sidebar_label: cpp-qt5-qhttpengine-server
4243

4344
## RESERVED WORDS
4445

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"><li>alignas</li>
46+
<ul class="column-ul">
47+
<li>alignas</li>
4648
<li>alignof</li>
4749
<li>and</li>
4850
<li>and_eq</li>

Diff for: ‎docs/generators/cpp-restbed-server.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,8 @@ sidebar_label: cpp-restbed-server
3030

3131
## LANGUAGE PRIMITIVES
3232

33-
<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>
33+
<ul class="column-ul">
34+
<li>bool</li>
3435
<li>char</li>
3536
<li>double</li>
3637
<li>float</li>
@@ -42,7 +43,8 @@ sidebar_label: cpp-restbed-server
4243

4344
## RESERVED WORDS
4445

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"><li>alignas</li>
46+
<ul class="column-ul">
47+
<li>alignas</li>
4648
<li>alignof</li>
4749
<li>and</li>
4850
<li>and_eq</li>

Diff for: ‎docs/generators/cpp-restsdk.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,8 @@ sidebar_label: cpp-restsdk
3333

3434
## LANGUAGE PRIMITIVES
3535

36-
<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>
36+
<ul class="column-ul">
37+
<li>bool</li>
3738
<li>char</li>
3839
<li>double</li>
3940
<li>float</li>
@@ -45,7 +46,8 @@ sidebar_label: cpp-restsdk
4546

4647
## RESERVED WORDS
4748

48-
<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>
49+
<ul class="column-ul">
50+
<li>alignas</li>
4951
<li>alignof</li>
5052
<li>and</li>
5153
<li>and_eq</li>

Diff for: ‎docs/generators/cpp-tizen.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,8 @@ sidebar_label: cpp-tizen
2525

2626
## LANGUAGE PRIMITIVES
2727

28-
<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>
28+
<ul class="column-ul">
29+
<li>bool</li>
2930
<li>double</li>
3031
<li>float</li>
3132
<li>int</li>
@@ -35,7 +36,8 @@ sidebar_label: cpp-tizen
3536

3637
## RESERVED WORDS
3738

38-
<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>
39+
<ul class="column-ul">
40+
<li>alignas</li>
3941
<li>alignof</li>
4042
<li>and</li>
4143
<li>and_eq</li>

0 commit comments

Comments
 (0)