/: JSDoc goes CI

Beautiful Javascript API-Docs made simple

View this example!

Doclets.io is in alpha phase. Please report issues or give feedback here.

JSDocMarkdown.doclets.yml

Reduce your setup time from hours to minutes. No server config, no build system setup!

Create beautiful API reference docs just out of standard JSDoc comments and Markdown formated articles. For Javascript and Node.js.

New release? No trouble, your docs are automatically updated for tags and selected branches. Continuous Integration for your docs!

Keep your repository clean from documentation artifacts like CSS and HTML files. A single small configuration file is all you need.

Bring your examples to life! Create executable and editable code snippets with the @playground tag. Powered by awesome Tonic!

Doclets will stay free for Open Source projects. Forever!

with GitHub

Doclets.io needs permissions to install a webhook

Add Repository

The source must be JSDoc commented

.doclets.yml

Create a simple configuration file

Push

Commit and push your changes

Doclets

Keep your docs in sync
On every change, for every release

We are always struggling to keep our code documented

Looks swell. Gotta try ...

Doclets makes it very easy to publish JSDoc commented projects

Safes Time & Money

Standard Formats

Versioning

No Spam

More Fun

Free for Open Source

Getting started

Publish your first API documentation in 3 Minutes