{"_id":"@acos/swagger-markdown","_rev":"1-537112550ca5a2b3c675cd05194e15b9","name":"@acos/swagger-markdown","dist-tags":{"latest":"1.0.1"},"versions":{"1.0.0":{"name":"@acos/swagger-markdown","version":"1.0.0","description":"Create markdown API documentation from swagger file","main":"index.js","scripts":{"test":"npm run test:app && npm run test:lint && npm run test:markdown","test:app":"jest","test:watch":"jest --watch","test:lint":"eslint . --ignore-pattern 'src/**/*.js' --ignore-pattern 'tests/**/*.spec.js' --ignore-pattern 'scripts/**/*.js'","test:markdown":"markdownlint ./examples/*.md -c .markdownlint.json","build":"tsc","build:watch":"tsc -w","prepublishOnly":"npm run build","commit":"git-cz","semantic-release":"semantic-release","make:examples":"ts-node ./scripts/make-examples.ts","prepare":"husky install"},"bin":{"swagger-markdown":"dist/index.js"},"config":{"commitizen":{"path":"cz-conventional-changelog"}},"commitlint":{"extends":["@commitlint/config-conventional"]},"lint-staged":{"{src,test}/**/*.js":["eslint --fix --ignore-pattern 'src/**/*.js' --ignore-pattern 'tests/**/*.spec.js' --ignore-pattern 'scripts/**/*.js'"]},"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/syroegkin/swagger-markdown.git"},"author":{"name":"Sergii Skorokhodov"},"license":"MIT","bugs":{"url":"https://github.com/syroegkin/swagger-markdown/issues"},"homepage":"https://github.com/syroegkin/swagger-markdown#readme","keywords":["swagger","md","markdown"],"devDependencies":{"@commitlint/cli":"^17.0.1","@commitlint/config-conventional":"^17.0.0","@semantic-release/changelog":"^6.0.1","@semantic-release/commit-analyzer":"^9.0.2","@semantic-release/git":"^10.0.1","@semantic-release/github":"^8.0.4","@semantic-release/npm":"^9.0.1","@semantic-release/release-notes-generator":"^10.0.3","@types/argparse":"^2.0.10","@types/chai":"^4.3.1","@types/jest":"^27.5.1","@types/node":"^17.0.35","@typescript-eslint/eslint-plugin":"^5.26.0","@typescript-eslint/parser":"^5.26.0","chai":"^4.3.6","commitizen":"^4.2.4","cz-conventional-changelog":"^3.3.0","eslint":"^8.16.0","eslint-config-airbnb-base":"15.0.0","eslint-plugin-import":"^2.26.0","husky":"^8.0.1","jest":"^28.1.0","lint-staged":"^12.4.2","markdownlint-cli":"^0.31.1","semantic-release":"^19.0.2","ts-jest":"^28.0.3","ts-node":"^10.8.0","typescript":"^4.7.2"},"dependencies":{"@apidevtools/swagger-parser":"^10.1.0","markdownlint":"^0.25.1","markdownlint-rule-helpers":"^0.16.0","openapi-types":"^11.0.1"},"gitHead":"f4331688f5c9353649f2315f97f2534cf84e6d18","_id":"@acos/swagger-markdown@1.0.0","_nodeVersion":"16.17.1","_npmVersion":"8.15.0","dist":{"integrity":"sha512-CZ1z7ta/Dlhk2KV0x4WaVReKVNsZb3g9aapZH/l/1ky03Jt7cThsBao0F6b6hP5JoxGBM4dcNwayll+9uDrgCA==","shasum":"640ace2191956fb52dafc10ce08ef714a152fa21","tarball":"https://registry.npmjs.org/@acos/swagger-markdown/-/swagger-markdown-1.0.0.tgz","fileCount":52,"unpackedSize":50573,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIGOzxiGHt1gYszONemq9/pgsTZYBhunNVwbUQTq0EYlcAiEAvRhwVb8m3Z/BARg75jKVEmZT4c3kfQqPjEi6XrLng50="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjis1hACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmqeJw/9EkCZGF/AVFTjQyDU6egk7ydBmDRMr0bA7rs9LcLT6sTKRXLR\r\nMmO36KzbJvHBbiX1gGf786GkMoCWhimeMjaQZCY7fGKXclNfTvVK40gx8FEO\r\np00vKyRn0dCjiDvvsjhXucXXITst/CI2oGLS7VNO+bFhgoM+uMrZF0XFQ1xo\r\nlf9QSePMwe3Dfr0urR9vNPifnoFyFx+r8S+sA/0Hd6Jkb+WT57sQujqpyZpf\r\n93P6WZ1Hz9stTLKcdGS1MI3CzRXApJRwuMjSOXRypVpBe/8qCiL6jZeolMFT\r\nXU3zYvK4sVE5TSDszk1sl2WjmoDkCbskus4mNHWf3374iaxQWC6FNcGts6QT\r\niZfjVCQVEZq+9NhDXYM6/0+WjLq5CIUmeJlGchKtmEkGVVZ5t3W4jDd8tuGd\r\nvSCyCkvQh7ZzMcsp7NHYnCtMUPDTqX8Lqfthrmc8WT0fd2C6GXOtNpp2f5l2\r\n6j7coVX1fj87t3p46L9wq42QL7geAUEcgslozRnBubSf/1dk56qExAESi2KR\r\nKH2gdHcSwfykccHEoGnln9RNc3stO86tCSu1JMC3ksAcGbyHPewORdmt90sn\r\n7mbV+6utc2zQj5/l6FSOKDbTffKD9QlXESfV9ehJw8rRAXoyKm70SP6kGHY2\r\nJCDX+BlA84WoezrnxFL8yNslCTsG8+EoJoE=\r\n=K3j0\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"aadityachakravarty","email":"aadityachakravarty@outlook.com"},"directories":{},"maintainers":[{"name":"aadityachakravarty","email":"aadityachakravarty@outlook.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/swagger-markdown_1.0.0_1670040929496_0.5962055836370095"},"_hasShrinkwrap":false},"1.0.1":{"name":"@acos/swagger-markdown","version":"1.0.1","description":"Create markdown API documentation from swagger file","main":"./dist/index.js","scripts":{"build":"tsc","build:watch":"tsc -w","prepublishOnly":"npm run build","commit":"git-cz","semantic-release":"semantic-release","make:examples":"ts-node ./scripts/make-examples.ts","prepare":"husky install"},"bin":{"swagger-markdown":"dist/index.js"},"config":{"commitizen":{"path":"cz-conventional-changelog"}},"commitlint":{"extends":["@commitlint/config-conventional"]},"lint-staged":{"{src,test}/**/*.js":["eslint --fix --ignore-pattern 'src/**/*.js' --ignore-pattern 'tests/**/*.spec.js' --ignore-pattern 'scripts/**/*.js'"]},"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/syroegkin/swagger-markdown.git"},"author":{"name":"Sergii Skorokhodov"},"license":"MIT","bugs":{"url":"https://github.com/syroegkin/swagger-markdown/issues"},"homepage":"https://github.com/syroegkin/swagger-markdown#readme","keywords":["swagger","md","markdown"],"devDependencies":{"@commitlint/cli":"^17.0.1","@commitlint/config-conventional":"^17.0.0","@semantic-release/changelog":"^6.0.1","@semantic-release/commit-analyzer":"^9.0.2","@semantic-release/git":"^10.0.1","@semantic-release/github":"^8.0.4","@semantic-release/npm":"^9.0.1","@semantic-release/release-notes-generator":"^10.0.3","@types/argparse":"^2.0.10","@types/chai":"^4.3.1","@types/jest":"^27.5.1","@types/node":"^17.0.35","@typescript-eslint/eslint-plugin":"^5.26.0","@typescript-eslint/parser":"^5.26.0","chai":"^4.3.6","commitizen":"^4.2.4","cz-conventional-changelog":"^3.3.0","eslint":"^8.16.0","eslint-config-airbnb-base":"15.0.0","eslint-plugin-import":"^2.26.0","husky":"^8.0.1","jest":"^28.1.0","lint-staged":"^12.4.2","markdownlint-cli":"^0.31.1","semantic-release":"^19.0.2","ts-jest":"^28.0.3","ts-node":"^10.8.0","typescript":"^4.7.2"},"dependencies":{"@apidevtools/swagger-parser":"^10.1.0","markdownlint":"^0.25.1","markdownlint-rule-helpers":"^0.16.0","openapi-types":"^11.0.1"},"types":"./dist/index.d.ts","gitHead":"2e2db957c7a5a3950db2e7a3516e8b8bc0eb691d","_id":"@acos/swagger-markdown@1.0.1","_nodeVersion":"16.17.1","_npmVersion":"8.15.0","dist":{"integrity":"sha512-fhwwycQqomDCaYOsUAConPH0ZRuvwIjjZtlhHCHkV2z366YNDwdLCAiM1fbFfGu7sgVFdv56neNbjGK86YNwNw==","shasum":"fe35da34c0cdae39c1b9e87665a934935db1b0dd","tarball":"https://registry.npmjs.org/@acos/swagger-markdown/-/swagger-markdown-1.0.1.tgz","fileCount":52,"unpackedSize":50236,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIEZyLAxWVx6bwMVxSEBLRH/unsMet20KB4c+LeHB6o1oAiBhgENINgvmh4a2ALqFIStz+PPlb93K8ulkUoOO4JbUKw=="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjitxtACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2Vmpy4Q/9EsYkCmGn94zZHjXAtOS1FNI1b+LQu7DhblGepkYSsuPxQ8aG\r\nSE+3GDuoPr5nAitQtGox7z1TPlLh6Zw90sW2OKHi6MCraP/L0O00Srnqd1if\r\nKh7hFxT+i57WYdf7XLkB2l1op2wv0w/IpCrYYXJzTDzBu6pTozz+BKFCaoQr\r\nyd45D8fNRq1oBRBjV5J9whLFd98PyZp0vJgKHroo8/UzMv6j6kEI6Ezy7808\r\n+k2LeDmUHliR69laar3MIqGcZhFVu5cHOJpL20ggvBMrSCJmqqhsjPGT2Dkq\r\nQyxZ6plF7vuTr3A6+A/VMnbEym6kkwyXebvT0XCfe8HI45uIvaVcvLDLYpUb\r\nWHkdXE4p2p2ZxUUeZDLjFJsAP2dLMRTmnN8ES9d8esUZVSdKStT4SO1Iuswu\r\nR3jKlCkW9PK+x+JRheNvkGD5tELG8jMaZo/N9QGJSDidyjNmpm3/CpOfnewD\r\nY6xpRONiBIqRILifarzJ1ha6ma7gNFM/foSMv49PN7KOyZflCWXZK2siblct\r\nZwyeXAWB+4e/q4may7D1WAY0C4YyW8WplfBGKSv761n9PNX8oxx3/CmFWJWh\r\noiYCz2MhFnpUeTa6WvvQFg+gC3udFf0c0Bl/JCnJqrvEuBnsMwwSJis3n5w+\r\n4JBQDXLF3ccs9+TYtsSzrCjzx+z6LQ+vOm4=\r\n=2lT8\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"aadityachakravarty","email":"aadityachakravarty@outlook.com"},"directories":{},"maintainers":[{"name":"aadityachakravarty","email":"aadityachakravarty@outlook.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/swagger-markdown_1.0.1_1670044780811_0.6281233222332099"},"_hasShrinkwrap":false}},"time":{"created":"2022-12-03T04:15:29.376Z","1.0.0":"2022-12-03T04:15:29.730Z","modified":"2022-12-03T05:19:41.121Z","1.0.1":"2022-12-03T05:19:41.034Z"},"maintainers":[{"name":"aadityachakravarty","email":"aadityachakravarty@outlook.com"}],"description":"Create markdown API documentation from swagger file","homepage":"https://github.com/syroegkin/swagger-markdown#readme","keywords":["swagger","md","markdown"],"repository":{"type":"git","url":"git+https://github.com/syroegkin/swagger-markdown.git"},"author":{"name":"Sergii Skorokhodov"},"bugs":{"url":"https://github.com/syroegkin/swagger-markdown/issues"},"license":"MIT","readme":"# swagger-markdown\n\n## To Do: Write a new documentations\n\n[![npm][npm-image]][npm-url] [![circle ci][circleci-image]][circleci-url]\n\nCLI script to turn swagger yaml into markdown files.\nSupports swagger 2.0 format only\n\nsee [examples](https://github.com/syroegkin/swagger-markdown/tree/master/examples) folder\n\n### Installation\n\n```bash\nnpm install -g swagger-markdown\n```\n\n### Usage\n\n```\nswagger-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 swagger 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```bash\nnpx swagger-markdown -i ./basic-auth.yaml\n```\n\n#### Example\n\n```bash\nswagger-markdown -i path/to/swagger/file.yaml\n```\n\nBy default it will create the new file within the same directory with the same name as swagger file but with .md extension.\nSo, if swagger file is placed in `project/api-doc/swagger.yaml` the new file will be created as `project/api-doc/swagger.md`\n\nYou can also use it as a npm script in your package.json:\n\n```bash\nnpm i --save-dev swagger-markdown\n```\n\n```json\n{\n    \"scripts\": {\n        \"md-docs\": \"swagger-markdown -i path/to/swagger.yaml\",\n        //...\n    }\n}\n```\n\n```bash\nnpm run md-docs\n```\n\n### Related\n\n* [swagger-markdown-ui](https://swagger-markdown-ui.netlify.app/) ([source](https://github.com/shaun-chiang/swagger-markdown-ui))\n\n[npm-url]: https://www.npmjs.com/package/swagger-markdown\n[npm-image]: https://img.shields.io/npm/v/swagger-markdown.svg\n\n[circleci-url]: https://circleci.com/gh/syroegkin/swagger-markdown/tree/master\n[circleci-image]: https://img.shields.io/circleci/project/syroegkin/swagger-markdown.svg\n","readmeFilename":"README.md"}