Skip to content

Commit

Permalink
readme improved to explain options
Browse files Browse the repository at this point in the history
  • Loading branch information
carlosrivera committed Mar 2, 2021
1 parent 0817cbb commit 812ef4c
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 1 deletion.
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@synx-ai/openapi2md",
"version": "0.2.2",
"version": "0.2.3",
"description": "Convert OpenAPI spec to Markdown files.",
"main": "dist/index.js",
"types": "dist/index.d.ts",
Expand Down
13 changes: 13 additions & 0 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,19 @@ convert('./example/petstore.json', './build');

For every [**operation**](https://swagger.io/docs/specification/paths-and-operations/) in `paths`, object with all references resolved will be passed to `templates/path.hdb`, please refer to default template for an example in how to use it.

Please note that before saving, prettify will be executed to format the output, you can disable it using the `<!-- prettier-ignore-start -->` tag, exmaple:

```html
<!-- prettier-ignore-start -->

<Tabs defaultValue="{{someVar}}" values={[
{{#each content}}
{ label: "{{@key}}", value: "{{@key}}" },
{{/each}}
]}>

<!-- prettier-ignore-end -->
```

## Roadmap
- [X] Create a cli.js file to execute commands using yarn or npm
Expand Down

0 comments on commit 812ef4c

Please sign in to comment.