Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/restarian/brace_document_specification

:arrow_down_small: A plugin for Brace Document which creates a package details document page for a module. :arrow_up_small:
https://github.com/restarian/brace_document_specification

document-management markdown

Last synced: 15 days ago
JSON representation

:arrow_down_small: A plugin for Brace Document which creates a package details document page for a module. :arrow_up_small:

Awesome Lists containing this project

README

        

# Brace Document Specification
## Synopsis

[![Build status](https://ci.appveyor.com/api/projects/status/6x7kahkrdntaxyqa?svg=true)](https://ci.appveyor.com/project/restarian/brace-document-specification)[![Downloads](https://img.shields.io/npm/dm/brace_document_specification.svg?svg=true)](https://npmjs.org/package/brace_document_specification)

| **The [Brace Suite]** | **[Ubuntu on Windows]** |
|:---------------------:|:-------------------------:|
| ![Brace logo] | ![Ubuntu on Windows logo] | |

[Brace Suite]: https://github.com/restarian/restarian/tree/master/brace/
[Ubuntu on Windows]: https://www.microsoft.com/en-us/store/p/ubuntu/9nblggh4msv6?activetab=pivot%3aoverviewtab

[Ubuntu on Windows logo]: https://raw.githubusercontent.com/restarian/restarian/master/doc/image/ubuntu_windows_logo.png
[Brace logo]: https://raw.githubusercontent.com/restarian/restarian/master/brace/doc/image/brace_logo_small.png

---
### Brace Document Specification help pages
* [Contributor code of conduct](https://github.com/restarian/brace_document_specification/blob/master/docs/contributor_code_of_conduct.md)
* [Guidelines for contributing](https://github.com/restarian/brace_document_specification/blob/master/docs/guidelines_for_contributing.md)
* **Synopsis**
* Specification
* [License information](https://github.com/restarian/brace_document_specification/blob/master/docs/specification/license_information.md)
* [Package information](https://github.com/restarian/brace_document_specification/blob/master/docs/specification/package_information.md)
* [Unit test output](https://github.com/restarian/brace_document_specification/blob/master/docs/specification/unit_test_output.md)

---

### What it is
A plugin for Brace Document which auto-generates a document page from the javascript module (package.json), file. The generated file is produced before the page content is written out.