Installations

npm install @acos/swagger-markdown

Developer Guide

BETA

Typescript

Yes

Module System

CommonJS

Node Version

16.17.1

NPM Version

8.15.0 Score

71.6

Supply Chain

90.8

Quality

74.9

Maintenance

100

Vulnerability

99.6

License

Pull Requests

Open

1

Total

186

Closed

42

Merged

143

Issues

Open

6

Total

27

Closed

21

Releases

38

v2.3.2

Updated on May 26, 2024

v2.3.1

Updated on Nov 11, 2023

v2.3.0

Updated on Apr 30, 2023

v2.2.1

Updated on Apr 14, 2023

v2.2.0

Updated on Apr 14, 2023

v2.1.0

Updated on Apr 07, 2023

View All 38 releases

Languages

3

TypeScript

JavaScript

Shell

TypeScript (96.4%)

JavaScript (3.41%)

Shell (0.19%)

Developer

syroegkin

Download Statistics

Total Downloads

6,316

Last Day

2

Last Week

63

Last Month

364

Last Year

3,667

GitHub Statistics

MIT License

248 Stars

510 Commits

87 Forks

5 Watchers

3 Branches

13 Contributors

Updated on Jun 20, 2025

Bundle Size

437.35 kB

Minified

122.34 kB

Minified + Gzipped

Bundlephobia

Maintainers

1

View All 13 Contributors

Package Meta Information

Latest Version

1.0.1

Package Id

@acos/swagger-markdown@1.0.1

Unpacked Size

49.06 kB

Size

13.76 kB

File Count

52

NPM Version

8.15.0

Node Version

16.17.1

Total Downloads

Cumulative downloads

Total Downloads

6,316

Dependencies

4

@apidevtools/swagger-parser markdownlint markdownlint-rule-helpers openapi-types

Dev Dependencies

28

swagger-markdown

To Do: Write a new documentations

CLI script to turn swagger yaml into markdown files. Supports swagger 2.0 format only

see examples folder

Installation

1npm install -g swagger-markdown

Usage

swagger-markdown [-h] [-v] -i [-o] [--skip-info]

Options:
  -h, --help      Show this help message and exit.
  -v, --version   Show program's version number and exit.
  -i , --input    Path to the swagger yaml file
  -o , --output   Path to the resulting md file
  --skip-info     Skip the title, description, version etc, whatever is in the info block.

Npx (requires no installation)

1npx swagger-markdown -i ./basic-auth.yaml

Example

1swagger-markdown -i path/to/swagger/file.yaml

By default it will create the new file within the same directory with the same name as swagger file but with .md extension. So, if swagger file is placed in project/api-doc/swagger.yaml the new file will be created as project/api-doc/swagger.md

You can also use it as a npm script in your package.json:

1npm i --save-dev swagger-markdown

1{
2    "scripts": {
3        "md-docs": "swagger-markdown -i path/to/swagger.yaml",
4        //...
5    }
6}

1npm run md-docs

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

3

SAST

Determines if the project uses static code analysis.

2

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

0

Maintained

Determines if the project is "actively maintained".

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

Score

2.6

/10

Last Scanned on 2025-06-23

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

@acos/swagger-markdown

Installations

Developer Guide

Yes

CommonJS

16.17.1

8.15.0

Score

Pull Requests

1

186

42

143

Issues

6

27

21

Releases

Languages

Developer

syroegkin

Download Statistics

GitHub Statistics

Bundle Size

437.35 kB

122.34 kB

Maintainers

Package Meta Information

Total Downloads

6,316

Dependencies

Dev Dependencies

swagger-markdown

To Do: Write a new documentations

Installation

Usage

Npx (requires no installation)

Example

Related

10

10

3

2

0

0

0

0

0

2.6

/10

Weekly Downloads

Monthly Downloads

Yearly Downloads