documentation.js - Documentation for modern JavaScript

  •        63

documentation.js is a documentation tool for mordern JavaScript. It Supports modern JavaScript: ES5, ES2017, JSX, Vue and Flow type annotations. It provides customizable output: HTML, JSON, Markdown, and more.

http://documentation.js.org/
https://github.com/documentationjs/documentation

Tags
Implementation
License
Platform

   




Related Projects

grunt-jsdoc - A grunt plugin to generate javascript doc by running jsdoc3 on your grunt projects.

  •    Javascript

This plugin enables you to integrate the generation of comments based documentation into your Grunt build. This plugin is a wrapper around jsdoc3. Please refer to the documentation for the documentation details.

FSharp.Formatting - F# tools for generating documentation (Markdown processor and F# code formatter)

  •    F#

The F# Formatting libraries (FSharp.CodeFormat.dll and FSharp.Markdown.dll) include an F# implementation of a Markdown parser and an F# code formatter that can be used to tokenize F# code and obtain information about tokens including tool-tips (as in Visual Studio and MonoDevelop) with type information. The library also comes with a sample that implements literate programming for F#.F# Formatting: Documentation tools provides more information about the library, how to contribute, etc. It also includes links to tutorials showing how to use the Markdown parser and F# code formatter.

website - :globe_with_meridians: The Babel documentation website

  •    Javascript

This is the source for the babeljs.io website, powered by Jekyll.This repo also contains Babel's source documentation.


ESDoc - Good Documentation for JavaScript

  •    Javascript

ESDoc is a documentation generator for JavaScript. It generates good documentation. It can measure documentation coverage, Integrate test codes into documentation, Parse ECMAScript proposals.

ECMADoc

  •    Javascript

ECMADoc generates professionally looking API documentation out of ECMAScript family of languages, such as JScript and JavaScript. Using the well known JDoc documentation format, developers can embed documentation right within the source code. This project is developed in C#.

yuidoc - YUI Javascript Documentation Tool

  •    HTML

YUI's JavaScript Documentation engine. 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.

tsdoc - A doc comment standard for the TypeScript language

  •    TypeScript

We are developing a library package @microsoft/tsdoc that provides an open source reference implementation of a parser. Using this library is an easy way to ensure that your tool is 100% compatible with the standard. These are just examples. Many other tools in today's web developer community want to interact with TypeScript doc comments. Each of these tools accepts a syntax that is loosely based on JSDoc, but encounters frustrating incompatibilities when attempting to coexist with other parsers.

dox - JavaScript documentation generator for node using markdown and jsdoc

  •    Javascript

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.This output can then be passed to a template for rendering. Look below at the "Properties" section for details.

VsDoc2JsDoc

  •    Javascript

The goal of this project is to convert VSDoc JavaScript comments of JayData classes to JSDoc comment format. Using this tool you can generate the API reference of your JayData components and keep your JavaScript documentation up-to-date.

DocumentJS - The sophisticated documentation engine

  •    Javascript

DocumentJS creates beautiful, articulate, multi-versioned documentation. With DocumentJS, you can Write documentation inline or in markdown files, Specify your code's behavior precisely with JSDoc and Google Closure Compiler annotations, Customize your site's theme and layout, Generate multi-version documentation.

doctrine - JSDoc parser

  •    Javascript

Doctrine is a JSDoc parser that parses documentation comments from JavaScript (you need to pass in the comment, not a whole JavaScript file). Doctrine can also be used in web browsers using Browserify.

pydoctor - Documentation Tool for Python

  •    Python

pydoctor is an API documentation tool for Python. It works by parsing the source code and processing the syntax trees of Python modules and packages, which has advantages and disadvantages over generating the documentation from examining live objects, as some other documentation tools do.

yard - YARD is a Ruby Documentation tool. The Y stands for "Yay!"

  •    Ruby

YARD is a documentation generation tool for the Ruby programming language. It enables the user to generate consistent, usable documentation that can be exported to a number of formats very easily, and also supports extending for custom Ruby constructs such as custom class level definitions. Below is a summary of some of YARD's notable features. 1. RDoc/SimpleMarkup Formatting Compatibility: YARD is made to be compatible with RDoc formatting. In fact, YARD does no processing on RDoc documentation strings, and leaves this up to the output generation tool to decide how to render the documentation.

swagger2markup - A Swagger to AsciiDoc or Markdown converter to simplify the generation of an up-to-date RESTful API documentation by combining documentation that’s been hand-written with auto-generated API documentation

  •    Java

The primary goal of this project is to simplify the generation of an up-to-date RESTful API documentation by combining documentation that’s been hand-written with auto-generated API documentation produced by Swagger. The result is intended to be an up-to-date, easy-to-read, on- and offline user guide, comparable to GitHub’s API documentation. The output of Swagger2Markup can be used as an alternative to swagger-ui and can be served as static content. NOTE: The Swagger Specification has been donated to to the Open API Initiative (OAI) and has been renamed to the OpenAPI Specification. Swagger2Markup converts a Swagger JSON or YAML file into several AsciiDoc or GitHub Flavored Markdown documents which can be combined with hand-written documentation. The Swagger source file can be located locally or remotely via HTTP. Swagger2Markup supports the Swagger 1.2 and 2.0 specification. Internally it uses the official swagger-parser and my markup-document-builder.

dox - JavaScript documentation generator for node using markdown and jsdoc

  •    Javascript

JavaScript documentation generator for node using markdown and jsdoc

pkgdown - Generate static html documentation for an R package

  •    R

pkgdown is designed to make it quick and easy to build a website for your package. You can see pkgdown in action at http://pkgdown.r-lib.org: this is the output of pkgdown applied to the latest version of pkgdown. Learn more in vignette("pkgdown") or ?build_site. This will generate a docs/ directory. The home page will be generated from your package’s README.md, and a function reference will be generated from the documentation in the man/ directory. If you are using GitHub, the easiest way to make this your package website is to check into git, then go to settings for your repo and make sure that the GitHub pages source is set to “master branch /docs folder”. Be sure to update the URL on your github repository homepage so others can easily navigate to your new site.

vue-styleguidist - Created from react styleguidist for Vue Components with a living style guide

  •    Javascript

Project was started when not finding a tool that generates documentation of components with hot reloading, read documentation and have a playground. Created from React Styleguidist, implement additional support to read and compile .vue files. Only supports 2.x. Vue Styleguidist is a style guide generator for Vue components. It lists component and shows live, editable usage examples based on Markdown files. You can use it to generate a static HTML page to share and publish or as a workbench for developing new components using hot reloaded dev server.

sphinx - Main repository for the Sphinx documentation builder

  •    Python

Sphinx is a tool that makes it easy to create intelligent and beautiful documentation for Python projects (or other documents consisting of multiple reStructuredText sources), written by Georg Brandl. It was originally created for the new Python documentation, and has excellent facilities for Python project documentation, but C/C++ is supported as well, and more languages are planned. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.