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

doks

v0.3.3

Published

A configurable, bring-your-own-template documentation generator aimed for user and developer documentation based on source code.

Downloads

57

Readme

doks

A configurable, bring-your-own-template documentation generator aimed for user and developer documentation based on source code.

Basic Use

You can either use doks as a command line tool (npm install -g doks) or programmatically, with var Parser = require('doks').Parser.

If you choose to run it from the command line, the best option is to create a doks.json file in the root of your repository, with a structure like this (taken from our doks.json):

{
  "language": "coffee",
  "glob": "lib/parser.coffee",
  "arrayTags": [
    "supports",
    "param"
  ]
}

Languages supported

  • coffee - coffeescript style comments, using ### as the start and end, or ###* as the start of the block, and `### as the end.
  • js - js/javadoc style comments, using /** and */ as the start and end tokens, respectively.
  • escapedCoffee - js-style comments, escaped for coffeescript usage. Tokens are the same as js-style comments, except they have a backtick (`) on the left of the opening token, and the right of the closing token.

Then just run doks and it will generate your documentation, based on your source code comments.

Whether you use the command line tool or run it yourself, the supported options are available here.

Themes

Themes are very flexible by design. You could build one from scratch, or work based off of the existing efforts put forth.

Themes should generally have a similar structure, like so:

core
vendor
views
config.json   // this is required
favicon.ico   // this should be the default doks favicon.ico
index.html    // this is required

A config.json should be structured like so:

{
  "keys": {
    "category": "package",
    "mainType": "category",
    "subType": "name"
  },
  "options": {
    "page": {
      "pageName": "Doks",
      "favicon": "favicon.ico",
      "showGitHubBadges": true
    },
    "nav": {
      "categorySeparate": false,
      "mainTypeRight": false,
      "useSearchBar": true
    },
    "content": {
      "showFileLabels": true,
      "sourceLink": "https://github.com/kellyirc/doks/tree/master/%filePath#L%lineNumber-L%endLineNumber"
    }
  }
}

However, the only required key here is options - doks uses that to merge user configuration into the theme configuration. Everything else is determined by the theme.