Skip to content

feat(docs): Group CLI examples by schema type with tabs #2696

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
koxudaxi merged 4 commits into from
Dec 19, 2025
Merged

feat(docs): Group CLI examples by schema type with tabs #2696

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
831c1a4
docs: Update CLI documentation examples to improve clarity and consis…
koxudaxi Dec 19, 2025
0e2f576
docs: update CLI reference documentation
github-actions[bot] Dec 19, 2025
ef994c7
add examples
koxudaxi Dec 19, 2025
e2151b1
docs: update CLI reference documentation
github-actions[bot] Dec 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 20 additions & 10 deletions docs/cli-reference/base-options.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,9 @@ For consistent cross-platform behavior, explicitly specify `--encoding utf-8`.

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

??? example "Input Schema"
??? example "Examples"

**Input Schema:**

```json
{
Expand All @@ -51,7 +53,7 @@ For consistent cross-platform behavior, explicitly specify `--encoding utf-8`.
}
```

??? example "Output"
**Output:**

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

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

??? example "Input Schema"
??? example "Examples"

**Input Schema:**

```json
{
Expand All @@ -109,7 +113,7 @@ schemas. Required unless using `--url` to fetch schema from a URL.
}
```

??? example "Output"
**Output:**

```python
# generated by datamodel-codegen:
Expand Down Expand Up @@ -147,7 +151,9 @@ json, yaml, csv, graphql.

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

??? example "Input Schema"
??? example "Examples"

**Input Schema:**

```json
{
Expand All @@ -158,7 +164,7 @@ json, yaml, csv, graphql.
}
```

??? example "Output"
**Output:**

```python
# generated by datamodel-codegen:
Expand Down Expand Up @@ -198,7 +204,9 @@ is written to stdout.

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

??? example "Input Schema"
??? example "Examples"

**Input Schema:**

```json
{
Expand All @@ -219,7 +227,7 @@ is written to stdout.
}
```

??? example "Output"
**Output:**

```python
# generated by datamodel-codegen:
Expand Down Expand Up @@ -258,7 +266,9 @@ Format: `HeaderName:HeaderValue`.

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

??? example "Input Schema"
??? example "Examples"

**Input Schema:**

```json
{
Expand All @@ -279,7 +289,7 @@ Format: `HeaderName:HeaderValue`.
}
```

??? example "Output"
**Output:**

```python
# generated by datamodel-codegen:
Expand Down
Loading
Loading