Skip to content

Commit

Permalink
docs: update about options and templates
Browse files Browse the repository at this point in the history
  • Loading branch information
sh1nj1 committed Dec 9, 2024
1 parent 16f7b8b commit 9407a0c
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,13 @@ to_markdown(apiFile, outputFile, templates_dir, options)
- If you want to use your own template, creates 'templates' directory and put [`api_doc_template.md.j2`](src/openapi_markdown/templates/api_doc_template.md.j2) file in it.
- You can change templates directory by passing it as the 3rd argument of `to_markdown`.

### Default templates

There are internal templates you can use. If not set default is used.

* templates - default
* templates/embed - prints objects hierarchially as list in every request/response

## Development

### Requirements
Expand Down

0 comments on commit 9407a0c

Please sign in to comment.