shinola

1.0.1 • Public • Published

shinola

Shins-as-a-service. Generate beautiful Shins Slate-compatible API documentation on the fly, from markdown or OpenApi / Swagger definitions

logo

Deploy

Then connect and submit a request like:

  • http://shinola.herokuapp.com/shins?url=http://url.to.markdown.md
  • http://shinola.herokuapp.com/openapi?url=http://url.to.openapi.json-or-yaml
  • http://shinola.herokuapp.com/openapi?url=http://url.to.openapi.json-or-yaml&raw=true

The last call returns the converted markdown, not the rendered HTML.

The server runs by default on port 5678 or as specified in the PORT environment variable

Dependents (0)

Package Sidebar

Install

npm i shinola

Weekly Downloads

0

Version

1.0.1

License

MIT

Unpacked Size

8.61 kB

Total Files

8

Last publish

Collaborators

  • mermade