https://github.com/lipp/doclets

Hosted automated jsdoc API documentation
https://github.com/lipp/doclets

Last synced: 9 months ago
JSON representation

Hosted automated jsdoc API documentation

• Host: GitHub
• URL: https://github.com/lipp/doclets
• Owner: lipp
• License: mit
• Created: 2015-12-09T21:34:26.000Z (about 10 years ago)
• Default Branch: master
• Last Pushed: 2017-03-27T00:05:09.000Z (almost 9 years ago)
• Last Synced: 2025-04-15T06:54:26.508Z (9 months ago)
• Language: JavaScript
• Homepage: https://doclets.io
• Size: 2.75 MB
• Stars: 207
• Watchers: 3
• Forks: 13
• Open Issues: 157
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# doclets

[![Join the chat at https://gitter.im/lipp/doclets](https://badges.gitter.im/lipp/doclets.svg)](https://gitter.im/lipp/doclets?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

[![Build Status](https://travis-ci.org/lipp/doclets.svg?branch=master)](https://travis-ci.org/lipp/doclets) [![Coverage Status](https://coveralls.io/repos/lipp/doclets/badge.svg?branch=master&service=github)](https://coveralls.io/github/lipp/doclets?branch=master) [![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com/)

# 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] (http://localhost:8080/lipp/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.