Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/bitovi/documentjs

The sophisticated documentation engine
https://github.com/bitovi/documentjs

Last synced: about 6 hours ago
JSON representation

The sophisticated documentation engine

Awesome Lists containing this project

README

        

# DocumentJS

[![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/bitovi/documentjs?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

[![Build Status](https://travis-ci.org/bitovi/documentjs.svg?branch=master)](https://travis-ci.org/bitovi/documentjs)
[![Build status](https://ci.appveyor.com/api/projects/status/f2e9ho3cwx98hajp/branch/master?svg=true)](https://ci.appveyor.com/project/matthewp/documentjs/branch/master)

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](https://developers.google.com/closure/compiler/docs/js-for-compiler)
annotations.
- Customize your site's theme and layout.
- Generate multi-version documentation.

Go to [documentjs.com](http://documentjs.com) for guides and documentation.

## Changelog

### 0.2.0 _Nov 27th, 2014_

- Added the `tags` [site config](http://documentjs.com/docs/DocumentJS.siteConfig.html). It allows custom tags.
- Options on non record types [#72](https://github.com/bitovi/documentjs/issues/72).
- `` is bold [#76](https://github.com/bitovi/documentjs/issues/76).
- Sidebar parents fixed [#75](https://github.com/bitovi/documentjs/pull/75).
- Code and Src are available almost everywhere [commit](https://github.com/bitovi/documentjs/commit/d51f8fb09e06c58fe8e12bd8ea6b93c7197c5ae1).
- Added `singlePage` [site config](http://documentjs.com/docs/DocumentJS.siteConfig.html). [commit](https://github.com/bitovi/documentjs/commit/0ccfbffbd5b84de0c433e2102c84c6e56059426d)