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

doxx

v2.1.1

Published

Generic, template based, HTML output for Dox documentation generator

Downloads

3,446

Readme

Doxx Deps Version Version

Doxx is a total refactoring of dox-foundation written in ES6, tranformed to ES5 with Babel, and is based on dox. It can automatically generate beautiful documentations and can further spice up your documentations using themes.

By default, Doxx uses doxx-theme-default which uses Twitter Bootstrap for the frontend framework and Prism.js for syntax highlighting.

Docs

The beautifully documentation can be found at GitHub.

Installation

# Install the module globally
$ npm i -g doxx

Usage

JavaScript JavaDoc style

/**
 * Create an array of all the right files in the source dir
 * @param      {String}   source path
 * @param      {Object}   options
 * @param      {Function} callback
 * @jsFiddle   A jsFiddle embed URL
 * @return     {Array} an array of string path
 */
function collectFiles(source, options, callback) {
  ...
}

CoffeeScript JavaDoc style

###*
 * Create an array of all the right files in the source dir
 * @param      {String}   source path
 * @param      {Object}   options
 * @param      {Function} callback
 * @jsFiddle   A jsFiddle embed URL
 * @return     {Array} an array of string path
###
collectFiles = (source, options, callback) ->
  ...

Notes

  • Doxx supports the following variations of @return and @jsFiddle:
    • @return, @returns
    • @jsfiddle, @jsFiddle, @JSFiddle

CLI

$ doxx --help

  Usage: doxx [options]

  Commands:
    cache                         Manages the Doxx cache. The available commands are clean and remove.

  Options:

    -h, --help                    Outputs usage information.
    -V, --version                 Outputs the version number.
    -r, --raw                     Outputs "raw" comments, leaving the markdown intact.
    -d, --debug                   Outputs parsed comments for debugging.
    -t, --title <string>          The title for the page produced.
    -s, --source <source>         The folder which should get parsed.
    -i, --ignore <directories>    Comma seperated list of directories to ignore. Default: test, public, static, view, views, templates.
    -T, --target <target>         The folder which will contain the results. Default: <CWD>/docs
    -e, --extension <extension>   Target files extension. Default: html
    -j, --template <template>     The Jade template file to use.
    -b, --theme <theme>           The name of the theme. e.g. doxx-theme-cayman or cayman.
  Examples:

    # parse a whole folder
    $ doxx --source lib --target docs

    # parse a whole folder and use a specific template
    $ doxx --template ./view/myowntpl.jade --source lib --target docs

Themes

Usage

With the release of 2.1.0, you are able to use different themes to spice up your documentations. To install a theme, simply use the --theme option followed by the name of the theme:

$ doxx --source lib --target docs --theme cayman
# or
$ doxx --source lib --target docs --theme doxx-theme-cayman

Notes

  • The prefix doxx-theme- is not necessary except when publishing your own themes.
  • While it is still possible to use templates, I would advise you to use themes instead.

Creating Themes

If you would like to create your own themes, see doxx-theme-starter-kit.

Related

  • grunt-doxx - Doxx grunt plugin automatically generates the documentation for your project.
  • gulp-doxx - Doxx documentation generator for gulp.

Roadmap

3.0.0

  • Switch the backend from bower to npm for themes. #79
  • Re-introduce Doxx with a new name. #83

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using gulp and mocha.

Changelog

The changes can be viewed here.

Donate

License

MIT License

Copyright (c) 2013 Francois-Guillaume Ribreau