Popularity
1.6
Stable
Activity
0.0
Stable
205
29
58

Description

jsdox is a simple jsdoc 3 generator. It pulls documentation tags based on a subset of jsdoc 3 from your javascript files and generates markdown files.

Relies on the JSDoc3 parser to get the full AST including comments.

Code Quality Rank: L4
Monthly Downloads: 0
Programming language: JavaScript
License: MIT License
Tags: Documentation    

jsdox alternatives and similar libraries

Based on the "Documentation" category

  • Beautiful docs

    is a documentation viewer based on markdown files.
  • documentation.js

    API documentation generator with support for ES2015+ and flow annotation.
  • sphinx

    a tool that makes it easy to create intelligent and beautiful documentation
  • docco

    is a quick-and-dirty, hundred-line-long, literate-programming-style documentation generator.
  • ESDoc

    4.6 0.0 L2 jsdox VS ESDoc
    is a good documentation generator for JavaScript.
  • dox

    4.2 1.9 L4 jsdox VS dox
    is a JavaScript documentation generator written with node. Dox no longer generates an opinionated structure or style for your docs, it simply gives you a JSON representation, allowing you to use markdown and JSDoc-style tags.
  • jsduck

    API documentation generator made for Sencha JavaScript frameworks, but can be used for other frameworks too.
  • Ronn

    3.1 0.0 L5 jsdox VS Ronn
    builds manuals. It converts simple, human readable textfiles to roff for terminal display, and also to HTML for the web.
  • YUIDoc

    is a Node.js application that generates API documentation from comments in source, using a syntax similar to tools like Javadoc and Doxygen.
  • styledocco

    generates documentation and style guide documents from your stylesheets.
  • dexy

    1.8 2.2 L4 jsdox VS dexy
    is a free-form literate documentation tool for writing any kind of technical document incorporating code.
  • ip-num

    A TypeScript library for working with ASN, IPv4, and IPv6 numbers.
  • coddoc

    is a jsdoc parsing library. Coddoc is different in that it is easily extensible by allowing users to add tag and code parsers through the use of coddoc.addTagHandler and coddoc.addCodeHandler. coddoc also parses source code to be used in APIs.
  • DevDocs

    is an all-in-one API documentation reader with a fast, organized, and consistent interface.

Do you think we are missing an alternative of jsdox or a related project?

Add another 'Documentation' Library

README

jsdox npm npm build status

jsdox is a simple jsdoc 3 generator. It pulls documentation tags based on a subset of jsdoc 3 from your javascript files and generates markdown files.

Relies on the JSDoc3 parser to get the full AST including comments.

CLI Options

Usage: jsdox [options] <file | directory>

--config <file> (alias -c): Configuration JSON file.

--All (alias -A): Generates documentation for all available elements including internal methods.

--debug (alias -d): Prints debugging information to the console.

--help (alias -H): Prints help and quits.

--version (alias -v): Prints the current version and quits.

--output <dir> (alias -o): Output directory. Default value is output.

--templateDir <dir> (alias -t): Template directory to use instead of built-in ones.

--index <name> (alias -i): Generates an index with the documentation. An optional file name can be provided as an argument. Default value is index.

--index-sort <type>: Defines how to sort the index. Options are: standard (sorted by name), namespace (sorted by package/module and name), and none (not sorted). Default value is standard.

--recursive (alias -r): Generates documentation in all subdirectories of the source folder.

--respect-recursive (alias --rr): Generate subdirectories and copy the original organization of the sources.

Resources

  • grunt-jsdox A grunt task to run jsdox on your project

Author and contributors

  • Pascal Belloncle (psq, Original author)
  • Sam Blowes (blowsie)
  • Todd Henderson (thenderson21)
  • Nic Jansma (nicjansma)
  • Joel Kemp (mrjoelkemp)
  • Ron Korving (ronkorving)
  • Mike MacMillan (mmacmillan)
  • Michael Martin-Smucker (mlms13)
  • Akeem McLennon (bluelaguna)
  • Gabor Sar (gaborsar)
  • Marc Trudel (stelcheck)
  • Anselm Stordeur (anselmstordeur)
  • Vladimir de Turckheim (vdeturckheim)

License

jsdox.js is freely distributable under the terms of the MIT license.

Copyright (c) 2012-2016 Sutoiku

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.


*Note that all licence references and agreements mentioned in the jsdox README section above are relevant to that project's source code only.