Skip to content

Commit a933013

Browse files
author
Eric Lin
committed
fix: remove docs path and update codeblocks highlight css
1 parent 879725f commit a933013

31 files changed

+62
-50
lines changed

‎.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -19,3 +19,4 @@ npm-debug.log*
1919
yarn-debug.log*
2020
yarn-error.log*
2121
.vercel
22+
.envrc

‎docs/advanced/configuration-files/sidebars.mdx

+21
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,24 @@
22
title: sidebars.js
33
sidebar_position: 4
44
---
5+
6+
By default, the sidebars are defined in `sidebars.js` in the root folder of this repo.
7+
8+
Under the key `config > presents > docs > sidebarPath` is where the path to the `sidebars.js` is referred for the docs plugin for Docusaurus.
9+
10+
```js title="docusaurus.config.js" {8}
11+
const config = {
12+
...
13+
presets: [
14+
[
15+
"classic",
16+
{
17+
docs: {
18+
sidebarPath: require.resolve("./sidebars.js"),
19+
...
20+
},
21+
},
22+
],
23+
],
24+
};
25+
```

‎docs/advanced/index.mdx

-11
This file was deleted.

‎docs/advanced/remove-openapi-demo.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ As part of this template repo, two options have been tested and provided for inc
1111
Click on the links to see the demo.
1212

1313
- [_redocusaurus_](/api)
14-
- [_docusaurus-plugin-openapi-docs_](/docs/category/test-api)
14+
- [_docusaurus-plugin-openapi-docs_](/category/test-api)
1515

1616
## Choosing between both plugins
1717

‎docs/test-api/add-pet.api.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -502,7 +502,7 @@ api:
502502
},
503503
}
504504
sidebar_class_name: "post api-method"
505-
info_path: docs/test-api/swagger-petstore-yaml
505+
info_path: test-api/swagger-petstore-yaml
506506
custom_edit_url: null
507507
---
508508

‎docs/test-api/create-user.api.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -544,7 +544,7 @@ api:
544544
},
545545
}
546546
sidebar_class_name: "post api-method"
547-
info_path: docs/test-api/swagger-petstore-yaml
547+
info_path: test-api/swagger-petstore-yaml
548548
custom_edit_url: null
549549
---
550550

‎docs/test-api/create-users-with-array-input.api.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -558,7 +558,7 @@ api:
558558
},
559559
}
560560
sidebar_class_name: "post api-method"
561-
info_path: docs/test-api/swagger-petstore-yaml
561+
info_path: test-api/swagger-petstore-yaml
562562
custom_edit_url: null
563563
---
564564

‎docs/test-api/create-users-with-list-input.api.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -558,7 +558,7 @@ api:
558558
},
559559
}
560560
sidebar_class_name: "post api-method"
561-
info_path: docs/test-api/swagger-petstore-yaml
561+
info_path: test-api/swagger-petstore-yaml
562562
custom_edit_url: null
563563
---
564564

‎docs/test-api/delete-order.api.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,7 @@ api:
127127
},
128128
}
129129
sidebar_class_name: "delete api-method"
130-
info_path: docs/test-api/swagger-petstore-yaml
130+
info_path: test-api/swagger-petstore-yaml
131131
custom_edit_url: null
132132
---
133133

‎docs/test-api/delete-pet.api.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,7 @@ api:
137137
},
138138
}
139139
sidebar_class_name: "delete api-method"
140-
info_path: docs/test-api/swagger-petstore-yaml
140+
info_path: test-api/swagger-petstore-yaml
141141
custom_edit_url: null
142142
---
143143

‎docs/test-api/delete-user.api.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,7 @@ api:
127127
},
128128
}
129129
sidebar_class_name: "delete api-method"
130-
info_path: docs/test-api/swagger-petstore-yaml
130+
info_path: test-api/swagger-petstore-yaml
131131
custom_edit_url: null
132132
---
133133

‎docs/test-api/find-pets-by-status.api.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -768,7 +768,7 @@ api:
768768
},
769769
}
770770
sidebar_class_name: "get api-method"
771-
info_path: docs/test-api/swagger-petstore-yaml
771+
info_path: test-api/swagger-petstore-yaml
772772
custom_edit_url: null
773773
---
774774

‎docs/test-api/find-pets-by-tags.api.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -749,7 +749,7 @@ api:
749749
},
750750
}
751751
sidebar_class_name: "get api-method"
752-
info_path: docs/test-api/swagger-petstore-yaml
752+
info_path: test-api/swagger-petstore-yaml
753753
custom_edit_url: null
754754
---
755755

‎docs/test-api/get-inventory.api.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,7 @@ api:
130130
},
131131
}
132132
sidebar_class_name: "get api-method"
133-
info_path: docs/test-api/swagger-petstore-yaml
133+
info_path: test-api/swagger-petstore-yaml
134134
custom_edit_url: null
135135
---
136136

‎docs/test-api/get-order-by-id.api.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -275,7 +275,7 @@ api:
275275
},
276276
}
277277
sidebar_class_name: "get api-method"
278-
info_path: docs/test-api/swagger-petstore-yaml
278+
info_path: test-api/swagger-petstore-yaml
279279
custom_edit_url: null
280280
---
281281

@@ -296,7 +296,7 @@ For valid response try integer IDs with value <= 5 or > 10. Other values will ge
296296

297297
successful operation
298298

299-
</div><div><MimeTabs schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs><TabItem label={"Schema"} value={"Schema"}><details style={{}} data-collapsed={false} open={true}><summary style={{"textAlign":"left"}}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={false} deprecated={undefined} schemaDescription={undefined} schemaName={"object"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"petId"} required={false} deprecated={undefined} schemaDescription={undefined} schemaName={"object"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"quantity"} required={false} deprecated={undefined} schemaDescription={undefined} schemaName={"int32"} qualifierMessage={"**Possible values:** `>= 1`"} defaultValue={1}></SchemaItem><SchemaItem collapsible={false} name={"shipDate"} required={false} deprecated={undefined} schemaDescription={"Estimated ship date"} schemaName={"date-time"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"status"} required={false} deprecated={undefined} schemaDescription={"Order Status"} schemaName={"string"} qualifierMessage={"**Possible values:** [`placed`, `approved`, `delivered`]"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"complete"} required={false} deprecated={undefined} schemaDescription={"Indicates whenever order was completed or not"} schemaName={"boolean"} qualifierMessage={undefined} defaultValue={false}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"id\": 0,\n \"petId\": 0,\n \"quantity\": 1,\n \"shipDate\": \"2023-01-30\",\n \"status\": \"placed\",\n \"complete\": false\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem><TabItem label={"application/xml"} value={"application/xml"}><SchemaTabs><TabItem label={"Schema"} value={"Schema"}><details style={{}} data-collapsed={false} open={true}><summary style={{"textAlign":"left"}}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={false} deprecated={undefined} schemaDescription={undefined} schemaName={"object"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"petId"} required={false} deprecated={undefined} schemaDescription={undefined} schemaName={"object"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"quantity"} required={false} deprecated={undefined} schemaDescription={undefined} schemaName={"int32"} qualifierMessage={"**Possible values:** `>= 1`"} defaultValue={1}></SchemaItem><SchemaItem collapsible={false} name={"shipDate"} required={false} deprecated={undefined} schemaDescription={"Estimated ship date"} schemaName={"date-time"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"status"} required={false} deprecated={undefined} schemaDescription={"Order Status"} schemaName={"string"} qualifierMessage={"**Possible values:** [`placed`, `approved`, `delivered`]"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"complete"} required={false} deprecated={undefined} schemaDescription={"Indicates whenever order was completed or not"} schemaName={"boolean"} qualifierMessage={undefined} defaultValue={false}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"<root>\n <id>0</id>\n <petId>0</petId>\n <quantity>1</quantity>\n <shipDate>2023-01-30</shipDate>\n <status>placed</status>\n <complete>false</complete>\n</root>"} language={"xml"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>
299+
</div><div><MimeTabs schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs><TabItem label={"Schema"} value={"Schema"}><details style={{}} data-collapsed={false} open={true}><summary style={{"textAlign":"left"}}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={false} deprecated={undefined} schemaDescription={undefined} schemaName={"object"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"petId"} required={false} deprecated={undefined} schemaDescription={undefined} schemaName={"object"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"quantity"} required={false} deprecated={undefined} schemaDescription={undefined} schemaName={"int32"} qualifierMessage={"**Possible values:** `>= 1`"} defaultValue={1}></SchemaItem><SchemaItem collapsible={false} name={"shipDate"} required={false} deprecated={undefined} schemaDescription={"Estimated ship date"} schemaName={"date-time"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"status"} required={false} deprecated={undefined} schemaDescription={"Order Status"} schemaName={"string"} qualifierMessage={"**Possible values:** [`placed`, `approved`, `delivered`]"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"complete"} required={false} deprecated={undefined} schemaDescription={"Indicates whenever order was completed or not"} schemaName={"boolean"} qualifierMessage={undefined} defaultValue={false}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"id\": 0,\n \"petId\": 0,\n \"quantity\": 1,\n \"shipDate\": \"2023-01-31\",\n \"status\": \"placed\",\n \"complete\": false\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem><TabItem label={"application/xml"} value={"application/xml"}><SchemaTabs><TabItem label={"Schema"} value={"Schema"}><details style={{}} data-collapsed={false} open={true}><summary style={{"textAlign":"left"}}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={false} deprecated={undefined} schemaDescription={undefined} schemaName={"object"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"petId"} required={false} deprecated={undefined} schemaDescription={undefined} schemaName={"object"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"quantity"} required={false} deprecated={undefined} schemaDescription={undefined} schemaName={"int32"} qualifierMessage={"**Possible values:** `>= 1`"} defaultValue={1}></SchemaItem><SchemaItem collapsible={false} name={"shipDate"} required={false} deprecated={undefined} schemaDescription={"Estimated ship date"} schemaName={"date-time"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"status"} required={false} deprecated={undefined} schemaDescription={"Order Status"} schemaName={"string"} qualifierMessage={"**Possible values:** [`placed`, `approved`, `delivered`]"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"complete"} required={false} deprecated={undefined} schemaDescription={"Indicates whenever order was completed or not"} schemaName={"boolean"} qualifierMessage={undefined} defaultValue={false}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"<root>\n <id>0</id>\n <petId>0</petId>\n <quantity>1</quantity>\n <shipDate>2023-01-31</shipDate>\n <status>placed</status>\n <complete>false</complete>\n</root>"} language={"xml"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>
300300

301301
Invalid ID supplied
302302

‎docs/test-api/get-pet-by-id.api.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -744,7 +744,7 @@ api:
744744
},
745745
}
746746
sidebar_class_name: "get api-method"
747-
info_path: docs/test-api/swagger-petstore-yaml
747+
info_path: test-api/swagger-petstore-yaml
748748
custom_edit_url: null
749749
---
750750

‎docs/test-api/get-user-by-name.api.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -973,7 +973,7 @@ api:
973973
},
974974
}
975975
sidebar_class_name: "get api-method"
976-
info_path: docs/test-api/swagger-petstore-yaml
976+
info_path: test-api/swagger-petstore-yaml
977977
custom_edit_url: null
978978
---
979979

‎docs/test-api/login-user.api.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -171,7 +171,7 @@ api:
171171
},
172172
}
173173
sidebar_class_name: "get api-method"
174-
info_path: docs/test-api/swagger-petstore-yaml
174+
info_path: test-api/swagger-petstore-yaml
175175
custom_edit_url: null
176176
---
177177

‎docs/test-api/logout-user.api.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ api:
9696
},
9797
}
9898
sidebar_class_name: "get api-method"
99-
info_path: docs/test-api/swagger-petstore-yaml
99+
info_path: test-api/swagger-petstore-yaml
100100
custom_edit_url: null
101101
---
102102

‎docs/test-api/new-pet.api.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -405,7 +405,7 @@ api:
405405
},
406406
}
407407
sidebar_class_name: "event api-method"
408-
info_path: docs/test-api/swagger-petstore-yaml
408+
info_path: test-api/swagger-petstore-yaml
409409
custom_edit_url: null
410410
---
411411

0 commit comments

Comments
 (0)