diff --git a/package.json b/package.json index d80ca20..d4fa695 100644 --- a/package.json +++ b/package.json @@ -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", diff --git a/readme.md b/readme.md index 92e8fae..d62efd1 100644 --- a/readme.md +++ b/readme.md @@ -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 `` tag, exmaple: + +```html + + + + + +``` ## Roadmap - [X] Create a cli.js file to execute commands using yarn or npm