Skip to content
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

Add output mode in README.md #77

Merged
merged 2 commits into from
Apr 3, 2024
Merged

Add output mode in README.md #77

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
81ec261
Add output mode in README.md
airycanon Apr 1, 2024
39452a2
Update README.md
thbkrkr Apr 3, 2024
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
11 changes: 11 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,17 @@ crd-ref-docs \
--templates-dir=templates/asciidoctor
```

Default output mode writes all data to a single output file.
You can choose between single mode and group mode by specifying the output mode.
In group mode, separate files are created for each API group, ensure the specified output path is an existing directory.
thbkrkr marked this conversation as resolved.
Show resolved Hide resolved
```
crd-ref-docs \
--source-path=$GOPATH/src/github.com/elastic/cloud-on-k8s/pkg/apis \
--config=config.yaml \
--output-path=./docs \
--output-mode=group
```

### Configuration

Configuration options such as types and fields to exclude from the documentation can be specified using a YAML file.
Expand Down