npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

dokker

v0.1.3

Published

Dokker.js creates professional Javascript code documentations.

Downloads

9

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

kengzkengzoceanhouse21oceanhouse21

Keywords

documentationJSDOCdoccaJavascript

Readme

dokker logo

Dokker.js creates professional Javascript code documentations.

See Dokker.js documentation as example.

Build Status

Features

  • Create or HTML or markdown documentation from JSDOC tags
  • Support for literate programming documentation
  • Live edit source code and watch changes
  • Include link to your Github repository
  • Customize your own templates with ejs or use default style
  • Create feature description from mocha test suite
  • Automagically include your README.md into the documentation
  • Use your own logo to make an astonishing impression
  • Deploy documentation to Github pages on the fly

Community

Gitter

Installation

Dokker is available as npm package. So the easiest way is to install dokker as global module into your project:

npm install -g dokker

Usage

After installation you can execute Dokker with the help of several terminal commands.

Bootstrap Dokker project

Dokker needs a configuration file to execute, such as a .travis or .jshintrc. You can easily create .dokker.json file with the dokker-init command from the root directory of your project or copy an example file.

Dokker provides a default template for your project. The template is based on an ejs file. Either you use the default template or modify it. If you choose for the latter you can copy the templates directory and tweak the ejs files how you like.

Create documentation

Creating a documentation is really simple with the help of Dokker. You just configure the .dokker.json file and execute dokker. Then you're done.

Live edit your documentation

If you want to work on your source file and see how the documentation evolves, you can do dokker-watch and it will open a browser with live preview.

Deploy to Github Pages

If you want to deploy your documentation to Github Pages, run gh-pages. Finally a separate branch, named gh-pages is created from the docs folder. That is enough for Github to serve your documentation. Please do not forget to git commit your changes before your run gh-pages command.

Dokker in the wild

Some examples by our users. Let us know what you did with Dokker too!

Further Reading

Contributors