Popularity
2.9
Stable
Activity
0.0
Stable
882
44
214

Monthly Downloads: 0
Programming language: HTML
License: BSD 3-clause "New" or "Revised" License
Tags: Documentation     API     Coffeescript     Docs     Apidocs     Javadoc     Jsdoc     Yui    
Latest version: v0.10.2

YUIDoc 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

    is a good documentation generator for JavaScript.
  • dox

    4.3 1.4 L4 YUIDoc 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.
  • codecrumbs

    is a visual tool for learning and documenting a codebase by putting breadcrumbs in source code.
  • jsduck

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

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

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

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

    is a JSDoc3 to Markdown documentation generator.
  • 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 YUIDoc or a related project?

Add another 'Documentation' Library

README

YUIDoc

YUI's JavaScript Documentation engine.

npm Version Build Status Dependency Status

Overview

YUIDoc is a Node.js application used at build time to generate API documentation for JavaScript code. YUIDoc is comment-driven and supports a wide range of JavaScript coding styles. The output of YUIDoc is API documentation formatted as a set of HTML pages including information about methods, properties, custom events and inheritance for JavaScript objects.

YUIDoc was originally written for the YUI Project; it uses YUI JavaScript and CSS in the generated files and it supports common YUI conventions like Custom Events. That said, it can be used easily and productively on non-YUI code.

Installation

npm install -g yuidocjs

Documentation

Contributing

Please see the [CONTRIBUTING.md](CONTRIBUTING.md).

License

This software is free to use under the Yahoo Inc. BSD license. See the [LICENSE file](LICENSE) for license text and copyright information.


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