npm package: @rollup-umd/word-documentation
Description: Rollup-UMD layout documentation to render a documentation with the styling of a text document and hability to print a nice PDF
Author: Dimitri Kopriwa
Latest version: 2.0.4

# word-documentation

![banner](https://user-images.githubusercontent.com/1866564/58097123-ec593d80-7bd6-11e9-86ae-4c0d1d0fe975.png)

[![Build Status](https://travis-ci.org/rollup-umd/word-documentation.svg?branch=master)](https://travis-ci.org/rollup-umd/word-documentation)
[![npm Version](https://img.shields.io/npm/v/@rollup-umd/word-documentation.svg?style=flat)](https://www.npmjs.com/package/@rollup-umd/word-documentation)
[![License](https://img.shields.io/npm/l/@rollup-umd/word-documentation.svg?style=flat)](https://www.npmjs.com/package/@rollup-umd/word-documentation)
[![NPM monthly downloads](https://img.shields.io/npm/dm/@rollup-umd/word-documentation.svg?style=flat)](https://npmjs.org/package/@rollup-umd/word-documentation)
[![NPM total downloads](https://img.shields.io/npm/dt/@rollup-umd/word-documentation.svg?style=flat)](https://npmjs.org/package/@rollup-umd/word-documentation)
[![npm Version](https://img.shields.io/node/v/@rollup-umd/word-documentation.svg?style=flat)](https://www.npmjs.com/package/@rollup-umd/word-documentation)
[![Module formats](https://img.shields.io/badge/module%20formats-umd%2C%20cjs%2C%20esm-green.svg?style=flat)](https://www.npmjs.com/package/@rollup-umd/word-documentation)
[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=com.github.rollup-umd.word-documentation&metric=coverage)](https://sonarcloud.io/dashboard?id=com.github.rollup-umd.word-documentation) [![Quality gate status](https://sonarcloud.io/api/project_badges/measure?project=com.github.rollup-umd.word-documentation&metric=alert_status)](https://sonarcloud.io/dashboard?id=com.github.rollup-umd.word-documentation)


Rollup-UMD layout documentation to render a documentation with the styling of a text document and hability to print a nice PDF

## Table of Contents

  - [Benefits](#benefits)
  - [Documentation](#documentation)
  - [Contributing](#contributing)
  - [License MIT](#license-mit)

---


## Benefits

- Use markdown as input to render HTML
- Print HTML into PDF 
- It work with ES6 so you can have digital and interactive presentation
- Left pan viewer with the content of the document
- Support theme customization thanks to [Bootstrap-Styled](https://github.com/bootstrap-styled)

## Documentation

Read [word-documentation documentation](https://rollup-umd.github.io/word-documentation).


## Contributing

If you want to contribute to word-documentation please see our [contributing and community guidelines](https://github.com/rollup-umd/word-documentation/blob/master/.github/CONTRIBUTING.md), they\'ll help you get set up locally and explain the whole process.

Please also note that all repositories under the rollup-umd organization follow our [Code of Conduct](https://github.com/rollup-umd/word-documentation/blob/master/CODE_OF_CONDUCT.md), make sure to review and follow it.

## License MIT

Copyright 2019 Yeutech Company Limited

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.