Skip to content

Commit 6a29f22

Browse files
feat(docs): Group CLI examples by schema type with tabs (#2696)
* docs: Update CLI documentation examples to improve clarity and consistency * docs: update CLI reference documentation 🤖 Generated by GitHub Actions * add examples * docs: update CLI reference documentation 🤖 Generated by GitHub Actions --------- Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
1 parent 8bb541a commit 6a29f22

10 files changed

Lines changed: 4973 additions & 2452 deletions

docs/cli-reference/base-options.md

Lines changed: 20 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,9 @@ For consistent cross-platform behavior, explicitly specify `--encoding utf-8`.
3131

3232
1. :material-arrow-left: `--encoding` - the option documented here
3333

34-
??? example "Input Schema"
34+
??? example "Examples"
35+
36+
**Input Schema:**
3537

3638
```json
3739
{
@@ -51,7 +53,7 @@ For consistent cross-platform behavior, explicitly specify `--encoding utf-8`.
5153
}
5254
```
5355

54-
??? example "Output"
56+
**Output:**
5557

5658
```python
5759
# generated by datamodel-codegen:
@@ -88,7 +90,9 @@ schemas. Required unless using `--url` to fetch schema from a URL.
8890

8991
1. :material-arrow-left: `--input` - the option documented here
9092

91-
??? example "Input Schema"
93+
??? example "Examples"
94+
95+
**Input Schema:**
9296

9397
```json
9498
{
@@ -109,7 +113,7 @@ schemas. Required unless using `--url` to fetch schema from a URL.
109113
}
110114
```
111115

112-
??? example "Output"
116+
**Output:**
113117

114118
```python
115119
# generated by datamodel-codegen:
@@ -147,7 +151,9 @@ json, yaml, csv, graphql.
147151

148152
1. :material-arrow-left: `--input-file-type` - the option documented here
149153

150-
??? example "Input Schema"
154+
??? example "Examples"
155+
156+
**Input Schema:**
151157

152158
```json
153159
{
@@ -158,7 +164,7 @@ json, yaml, csv, graphql.
158164
}
159165
```
160166

161-
??? example "Output"
167+
**Output:**
162168

163169
```python
164170
# generated by datamodel-codegen:
@@ -198,7 +204,9 @@ is written to stdout.
198204

199205
1. :material-arrow-left: `--output` - the option documented here
200206

201-
??? example "Input Schema"
207+
??? example "Examples"
208+
209+
**Input Schema:**
202210

203211
```json
204212
{
@@ -219,7 +227,7 @@ is written to stdout.
219227
}
220228
```
221229

222-
??? example "Output"
230+
**Output:**
223231

224232
```python
225233
# generated by datamodel-codegen:
@@ -258,7 +266,9 @@ Format: `HeaderName:HeaderValue`.
258266

259267
1. :material-arrow-left: `--url` - the option documented here
260268

261-
??? example "Input Schema"
269+
??? example "Examples"
270+
271+
**Input Schema:**
262272

263273
```json
264274
{
@@ -279,7 +289,7 @@ Format: `HeaderName:HeaderValue`.
279289
}
280290
```
281291

282-
??? example "Output"
292+
**Output:**
283293

284294
```python
285295
# generated by datamodel-codegen:

0 commit comments

Comments
 (0)