{"_id":"openapi-markdown","_rev":"3-71cd0d91c504b871fa6485cc8f1e2fa3","name":"openapi-markdown","dist-tags":{"latest":"1.2.3"},"versions":{"1.2.1":{"name":"openapi-markdown","version":"1.2.1","description":"Create markdown API documentation from swagger/openapi files","main":"index.js","scripts":{"test":"npm run test:app && npm run test:lint","test:app":"mocha \"tests/**/*.spec.js\"","test:watch":"mocha --watch \"tests/**/*.spec.js\"","test:lint":"eslint .","build":"babel app --out-dir bin","prepare":"npm run build","prepublish":"npm run build","commit":"git-cz","semantic-release":"semantic-release"},"bin":{"swagger-markdown":"bin/index.js"},"config":{"commitizen":{"path":"cz-conventional-changelog"}},"commitlint":{"extends":["@commitlint/config-conventional"]},"lint-staged":{"{src,test}/**/*.js":["eslint --fix","git add"]},"husky":{"hooks":{"commit-msg":"commitlint -E HUSKY_GIT_PARAMS","pre-commit":"lint-staged"}},"release":{"plugins":["@semantic-release/commit-analyzer","@semantic-release/release-notes-generator","@semantic-release/changelog","@semantic-release/npm","@semantic-release/git","@semantic-release/github"]},"repository":{"type":"git","url":"git+https://github.com/theBenForce/openapi-markdown.git"},"author":{"name":"Sergii Skorokhodov"},"license":"MIT","bugs":{"url":"https://github.com/theBenForce/openapi-markdown/issues"},"homepage":"https://github.com/theBenForce/openapi-markdown#readme","babel":{"presets":["env"]},"keywords":["swagger","md","markdown"],"devDependencies":{"@commitlint/cli":"^8.1.0","@commitlint/config-conventional":"^8.0.0","@semantic-release/changelog":"^3.0.2","@semantic-release/commit-analyzer":"^6.1.0","@semantic-release/git":"^7.0.8","@semantic-release/github":"^5.2.10","@semantic-release/npm":"^5.1.10","@semantic-release/release-notes-generator":"^7.1.4","babel-cli":"^6.26.0","babel-core":"^6.26.3","babel-preset-env":"^1.7.0","chai":"^4.2.0","commitizen":"^4.0.3","cz-conventional-changelog":"^2.1.0","eslint":"^5.16.0","eslint-config-airbnb-base":"13.1.0","eslint-plugin-import":"^2.17.3","husky":"^2.3.0","lint-staged":"^8.1.7","mocha":"^6.1.4","semantic-release":"^15.13.24"},"dependencies":{"argparse":"^1.0.10","js-yaml":"^3.13.1"},"gitHead":"5617b6c53e71f9be6c50869a6c7fde1ce75d466d","_id":"openapi-markdown@1.2.1","_nodeVersion":"12.13.0","_npmVersion":"6.13.0","dist":{"integrity":"sha512-8RasucafXuRJyQp90VBOksH4ZyqFFJzVSfcnyKPDhi9rRkdNfiKnMGQF93DgIk/t8m6+4rlWozK8R/v5zogRSg==","shasum":"766d5fa0cf6469b4f3f08e85351594cf0ba63c7c","tarball":"https://registry.npmjs.org/openapi-markdown/-/openapi-markdown-1.2.1.tgz","fileCount":19,"unpackedSize":25955,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJd0tI5CRA9TVsSAnZWagAAd3sP/iqKFz0jBG7oGgmWo0R/\nzKrZ8yhyYyFiPLydIE07rfDTsSH290ldujXEBMRnHQWyGBaOWYitelj5FeRy\ngrMNbHwv2y1ggx4R+cQ/kZjOSkxCDhlmj3mZPSi3KNqX6rl4BwU6thIEo4bN\n495yDxlMCexjmZin3JhU6zWZiReiaCah+/p7CABr0gdLF167eMzfjugn24uw\naa4coViu9w3eNL1QHKX/wlyNiRWCue/1suvy4WWrUXCRGng2IRx+1bvXCUhK\nb6FsAB/UULV8Q0WWOpxz2NMAVF97/vA3K1ZT6o2NqSavGTxUDQfEGytuOPFe\nNKlF5lZSo8N6b2x5lwLHx/WsrGhVzQa6jSYiAS/FUqv0P62lfKIVI6ceOTua\nnjzfU0U2rSQFHTSIL7KTIy4FNZ1VKP1O6swHp335by7UHraGN3Tohr9y+6Fs\nBZJuA36B+AxeaY+JrVVSOvKM8KsZ63bkVnihyXgsGuLdyk8rvDWX9eVKWXww\nFwgnZnJrgU3cOXbuBy3UhDS3e4uuCF9h2noTF1QvWKjG7kPBCsdxDd59GMzI\nWTRJH8GTw6ekOu5Lk6iZAEozIsrprmbKm8yhU5Gk5V3y3xQ45WJJjxHcebYe\ntr9i+0GzvZZ02QD5cy/ifrBx+4FagSrMKZ3Ilp89FoVaM74G/bAKRK3Z2CmX\nNp1L\r\n=hU3P\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIDNrdj84i7VQMkUjFFvD+f7o6PDJ0jbFrgiupfqliijEAiAzeatOe/Thahg7JsEh0HcJ1CvLeJ3b/ZIUb6PecCqMLw=="}]},"maintainers":[{"name":"benforce","email":"benforce@gmail.com"}],"_npmUser":{"name":"benforce","email":"benforce@gmail.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/openapi-markdown_1.2.1_1574097465033_0.09064807608932113"},"_hasShrinkwrap":false},"1.2.2":{"name":"openapi-markdown","version":"1.2.2","description":"Create markdown API documentation from swagger/openapi files","main":"index.js","scripts":{"test":"npm run test:app && npm run test:lint","test:app":"mocha \"tests/**/*.spec.js\"","test:watch":"mocha --watch \"tests/**/*.spec.js\"","test:lint":"eslint .","build":"babel app --out-dir bin","prepare":"npm run build","prepublish":"npm run build","commit":"git-cz","semantic-release":"semantic-release"},"bin":{"swagger-markdown":"bin/index.js"},"config":{"commitizen":{"path":"cz-conventional-changelog"}},"commitlint":{"extends":["@commitlint/config-conventional"]},"lint-staged":{"{src,test}/**/*.js":["eslint --fix","git add"]},"husky":{"hooks":{"commit-msg":"commitlint -E HUSKY_GIT_PARAMS","pre-commit":"lint-staged"}},"release":{"plugins":["@semantic-release/commit-analyzer","@semantic-release/release-notes-generator","@semantic-release/changelog","@semantic-release/npm","@semantic-release/git","@semantic-release/github"]},"repository":{"type":"git","url":"git+https://github.com/theBenForce/openapi-markdown.git"},"author":{"name":"Sergii Skorokhodov"},"license":"MIT","bugs":{"url":"https://github.com/theBenForce/openapi-markdown/issues"},"homepage":"https://github.com/theBenForce/openapi-markdown#readme","babel":{"presets":["env"]},"keywords":["swagger","md","markdown"],"devDependencies":{"@commitlint/cli":"^8.1.0","@commitlint/config-conventional":"^8.0.0","@semantic-release/changelog":"^3.0.2","@semantic-release/commit-analyzer":"^6.1.0","@semantic-release/git":"^7.0.8","@semantic-release/github":"^5.2.10","@semantic-release/npm":"^5.1.10","@semantic-release/release-notes-generator":"^7.1.4","babel-cli":"^6.26.0","babel-core":"^6.26.3","babel-preset-env":"^1.7.0","chai":"^4.2.0","commitizen":"^4.0.3","cz-conventional-changelog":"^2.1.0","eslint":"^5.16.0","eslint-config-airbnb-base":"13.1.0","eslint-plugin-import":"^2.17.3","husky":"^2.3.0","lint-staged":"^8.1.7","mocha":"^6.1.4","semantic-release":"^15.13.24"},"dependencies":{"argparse":"^1.0.10","js-yaml":"^3.13.1"},"gitHead":"a1d3ba8682e1f9cc177054e75eaeb1631e617bc9","_id":"openapi-markdown@1.2.2","_nodeVersion":"12.13.0","_npmVersion":"6.13.0","dist":{"integrity":"sha512-wkWLQ/Eyet+LOYkfbWVoAPcRWgX2ZWzK8M2HNtR9mAm1W1bPnCLlebicB9hijs54iQ0epa1iM7A5rCyFsAzT6A==","shasum":"1b2a36866e9c3eabb3a6ba334f4dcfca0f86d5cd","tarball":"https://registry.npmjs.org/openapi-markdown/-/openapi-markdown-1.2.2.tgz","fileCount":19,"unpackedSize":26774,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJd0tQLCRA9TVsSAnZWagAAg5kP/05/7/Eg7RBhjhdTiuvk\nflLI6zivTzou8ylzSiciupVU259/Kptebb+P6pIzq8xYzOOdJlgpVr4XIEat\nKOx43PlWc/wVK48Ix6/E1tXSDxiJVg7kuh/s0lkE5/q2r1WMvYVRB1CQDlT4\nWUd+asRodSLXDMJBZFeRuK29aczct/tmIvwEMCYbHkT7VBBeHgo+5u+DzYT4\nMjxMSEO/pAKKK/dEt3O12H2yTTLQrd0cu/wn/skctSGz4vSR8yS6o//6X0l+\n8rJSrecbqrQaVDYv/YIq0Ccaqi3uiazouQIctulkgTBQa6rNIUTBHg1PirgB\nS4Ala1E/TDAgR7eN/sEmiNpmX3GVe/sMQFkwvFXePGgWVVjJi1n3a8dkCg1p\nslHXbByZPQaXvbLJmI1ax9br1jeVUVOV1ZnT2PdRMYjokTj8njcJcACowWcG\n8yEJQigRYKHbWFgNVqcFzdwHi3NnMnqWNNTIR+c3xh+Mep9DBH71HNVmDsaj\n9nsEwu6wwi48A3K72veqMPLbJeVDmdOu7C5wxZyKMJTJ2rIem5/H2R/vgL1J\n0tdEuwMTH8DkDwqHH0AwJlKhkb3cF4kRtvof+w6iuHwHwdM7VwozM9iYSdWr\n0cczc8Og6K1okbp5y+jNyRW/WcUU7x+yKZubu1eWkaEb8BGNyzyCRzTuVCIi\n+IXC\r\n=d6ma\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDvWn3/j033BJGBtPJsWHXn8eHIyTUh+y/4U1XGr1SDagIhAJhke5D9Lm3uX5B3j5VWT+SDFtI0J/7yXw0U4KFR5iOH"}]},"maintainers":[{"name":"benforce","email":"benforce@gmail.com"}],"_npmUser":{"name":"benforce","email":"benforce@gmail.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/openapi-markdown_1.2.2_1574097931515_0.32246600073279863"},"_hasShrinkwrap":false},"1.2.3":{"name":"openapi-markdown","version":"1.2.3","description":"Create markdown API documentation from swagger/openapi files","main":"index.js","scripts":{"test":"npm run test:app && npm run test:lint","test:app":"mocha \"tests/**/*.spec.js\"","test:watch":"mocha --watch \"tests/**/*.spec.js\"","test:lint":"eslint .","build":"babel app --out-dir bin","prepare":"npm run build","prepublish":"npm run build","commit":"git-cz","semantic-release":"semantic-release"},"bin":{"openapi-markdown":"bin/index.js"},"config":{"commitizen":{"path":"cz-conventional-changelog"}},"commitlint":{"extends":["@commitlint/config-conventional"]},"lint-staged":{"{src,test}/**/*.js":["eslint --fix","git add"]},"husky":{"hooks":{"commit-msg":"commitlint -E HUSKY_GIT_PARAMS","pre-commit":"lint-staged"}},"release":{"plugins":["@semantic-release/commit-analyzer","@semantic-release/release-notes-generator","@semantic-release/changelog","@semantic-release/npm","@semantic-release/git","@semantic-release/github"]},"repository":{"type":"git","url":"git+https://github.com/theBenForce/openapi-markdown.git"},"author":{"name":"Sergii Skorokhodov"},"license":"MIT","bugs":{"url":"https://github.com/theBenForce/openapi-markdown/issues"},"homepage":"https://github.com/theBenForce/openapi-markdown#readme","babel":{"presets":["env"]},"keywords":["swagger","md","markdown"],"devDependencies":{"@commitlint/cli":"^8.1.0","@commitlint/config-conventional":"^8.0.0","@semantic-release/changelog":"^3.0.2","@semantic-release/commit-analyzer":"^6.1.0","@semantic-release/git":"^7.0.8","@semantic-release/github":"^5.2.10","@semantic-release/npm":"^5.1.10","@semantic-release/release-notes-generator":"^7.1.4","babel-cli":"^6.26.0","babel-core":"^6.26.3","babel-preset-env":"^1.7.0","chai":"^4.2.0","commitizen":"^4.0.3","cz-conventional-changelog":"^2.1.0","eslint":"^5.16.0","eslint-config-airbnb-base":"13.1.0","eslint-plugin-import":"^2.17.3","husky":"^2.3.0","lint-staged":"^8.1.7","mocha":"^6.1.4","semantic-release":"^15.13.24"},"dependencies":{"argparse":"^1.0.10","js-yaml":"^3.13.1"},"gitHead":"0d3db5a9fdaed41c369e5dc1c34b6079ff6b8f67","_id":"openapi-markdown@1.2.3","_nodeVersion":"12.13.0","_npmVersion":"6.13.0","dist":{"integrity":"sha512-WxlKjCaVlUBNP/70AoVYueokrdJUYGq1wiMV8w8EhHpQElt53dVQT5EOO35lAfFcYus0a/CUaSgNYQeyp2Iwyg==","shasum":"dcf6e4bffb451d37f62b69144a7e6dfef4b66d3c","tarball":"https://registry.npmjs.org/openapi-markdown/-/openapi-markdown-1.2.3.tgz","fileCount":19,"unpackedSize":27016,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJd0tawCRA9TVsSAnZWagAAEd0P/3W5ohvxMS1wmq9aXrRQ\n0OHmsL/4S9cTZvIHx/7MiOD5vtUwYPbxgPJTolOL5jAkQ1M29Z6s0JAsj1uB\n7LfKhhM0MYfaD2UwDZ878s2JELWCIiEUMwDiBmD6WTsg0vgL6tYiqKEw99gJ\n6ZxVe7fdxchdFMc7ACNnxkkrHBr5UwWeHiWBY7tga+d8bPWhJ6JeMbpfK0te\nr9UOpv+EcyOze3Bq/f/q0riYjJBZthWCc9hCAEumR/OE9mewh2WHnxx+uqHE\nUE7F8c5as1/s0KF5K8TePp4U3EMmFdQUtjJsNDYppLkuw1EGwdBFG2l7VOzT\nn1596895SHZbHaCJ8EpscDzRA4K+yWm6ow1jzxf4iSu7yEOEF0e+D0ayf5Js\nnS/JRoRboT5VjkynIwIKufs1opjo90rUK1f6wMwvRz3ic9mUxk+u95y+ZKKs\n4vjSvSnQS8f6Jq60lQRudLUC82Fj0yTMuktzZZUooU7cPdsBPVz7G0txhWm3\n6Ma2kEvZhfHLIHqPBdIhznooLK4ExKtJo6095//hoWZb/QH0+jPaWqB2Sxfm\nSqSYHXhw6KqV0VlrFneWg+lEKGxtmbb51p2xryjwdWZUl5HTducfI4QQnsk2\nbbx/Spl/sGRmWwqpOfXgjamFeMYMYrJn3DHVT+B4hH374PoNB++yFDny6Q9t\n6OpA\r\n=plNP\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCOG84caDT0xhaN9kRh2o35Jnollc+gNKLnlIBEiUHmSAIhANP3cFsKdlCQNZaSxFTighLc44mM0SX+gRmJLJI332kF"}]},"maintainers":[{"name":"benforce","email":"benforce@gmail.com"}],"_npmUser":{"name":"benforce","email":"benforce@gmail.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/openapi-markdown_1.2.3_1574098608516_0.6930739916308839"},"_hasShrinkwrap":false}},"time":{"created":"2019-11-18T17:17:45.032Z","1.2.1":"2019-11-18T17:17:45.148Z","modified":"2022-05-12T06:02:32.882Z","1.2.2":"2019-11-18T17:25:31.603Z","1.2.3":"2019-11-18T17:36:48.697Z"},"maintainers":[{"name":"benforce","email":"benforce@gmail.com"}],"description":"Create markdown API documentation from swagger/openapi files","homepage":"https://github.com/theBenForce/openapi-markdown#readme","keywords":["swagger","md","markdown"],"repository":{"type":"git","url":"git+https://github.com/theBenForce/openapi-markdown.git"},"author":{"name":"Sergii Skorokhodov"},"bugs":{"url":"https://github.com/theBenForce/openapi-markdown/issues"},"license":"MIT","readme":"# openapi-markdown\n\n[![npm][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Maintainability][cliamte-image]][climate-url]\n\nCLI script to turn swagger/OpenAPI yaml into markdown files.\nPrimarily supports swagger 2.0, with some OpenAPI 3.0 features.\n\n### Installation\n\n    npm install -g openapi-markdown\n\n### Usage\n\n```\nopenapi-markdown [-h] [-v] -i [-o] [--skip-info]\n\nOptions:\n  -h, --help      Show this help message and exit.\n  -v, --version   Show program's version number and exit.\n  -i , --input    Path to the openapi yaml file\n  -o , --output   Path to the resulting md file\n  --skip-info     Skip the title, description, version etc, whatever is in the info block.\n\n```\n\n### Npx (requires no installation)\n\n```\nnpx openapi-markdown -i ./basic-auth.yaml\n```\n\n#### Example:\n\n```javascript\nopenapi-markdown -i path/to/openapi/file.yaml\n```\n\nBy default it will create the new file within the same directory with the same name as openapi file but with .md extension.\nSo, if openapi file is placed in `project/api-doc/openapi.yaml` the new file will be created as `project/api-doc/openapi.md`\n\nYou can also use it as a npm script in your package.json:\n\n    npm i --save-dev openapi-markdown\n\n```jsonc\n{\n  \"scripts\": {\n    \"md-docs\": \"openapi-markdown -i path/to/openapi.yaml\"\n    //...\n  }\n}\n```\n\n    npm run md-docs\n\n[npm-url]: https://www.npmjs.com/package/openapi-markdown\n[npm-image]: https://img.shields.io/npm/v/openapi-markdown.svg\n[travis-url]: https://travis-ci.org/theBenForce/openapi-markdown\n[travis-image]: https://travis-ci.org/theBenForce/openapi-markdown.svg?branch=master\n[climate-url]: https://codeclimate.com/github/theBenForce/openapi-markdown/maintainability\n[cliamte-image]: https://api.codeclimate.com/v1/badges/a0f65d3365c2a609239b/maintainability\n","readmeFilename":"README.md"}