JavaScript
Need help with doclets?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.
lipp

Description

Hosted automated jsdoc API documentation

207 Stars 14 Forks MIT License 486 Commits 160 Opened issues

Services available

Need anything else?

doclets

Join the chat at https://gitter.im/lipp/doclets Build Status Coverage Status js-standard-style

Dev setup

$ docker-compose -f docker-compose-dev.yml up

Populate local DB

$ DEV=1 node bin/replay-events.js

Run webserver locally

$ DEV=1 node bin/server.js

To view a doc page, you have to know the repo name (as in `fixtures/events/*/payload.js). e.g. numbers.js

Unit test setup

$ docker-compose -f docker-compose-test.yml up

Run tests locally

$ TEST=1 npm test

Adding users/repos does not work with the local server :( This is due to GitHub WebHook configuration and GitHub OAuth wich require fix urls.

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.