This repository has been archived by the owner. It is now read-only.
A microservice to transform jsdoc annotated js to markdown
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
LICENSE
README.md
index.js
package.json
yarn.lock

README.md

JSDoc to markdown as a service

This is a Zeit micro service to turn a single file of code into markdown, to be shown wherever.

Available at jsdoc.now.sh, just post your code as source.

All options are visible at jsdoc2md/jsdoc-to-markdown

Example:

curl -d '{"source":"/** This is a description of the foo function. */\nfunction foo() {}"}' https://jsdoc.now.sh

License

MIT