@economist/doc-pack 1.0.8

This module provides documentation generation for `provision-react-component` generated modules.

Homepage: http://economist-components.github.io/doc-pack

Platform: npm

Language: Shell

License: MIT

Repository: https://github.com/economist-components/doc-pack

View on registry: https:[email protected]/doc-pack

Direct download link: https:[email protected][email protected]/doc-pac...

Install: npm install @[email protected]


doc-pack

This module provides documentation generation for provision-react-component generated modules.

How to use

Simply require the Handlebars helpers to help render templates:

Handlebars.registerHelper(require('@economist/doc-pack'));

You can also register the partials that come with the doc-pack:

Handlebars.registerPartial(fs.readFileSync(require.resolve('@economist/doc-pack/partials/component-example.hbs')));
Handlebars.registerPartial(fs.readFileSync(require.resolve('@economist/doc-pack/partials/component-preview.hbs')));
Handlebars.registerPartial(fs.readFileSync(require.resolve('@economist/doc-pack/partials/component-readme.hbs')));
Handlebars.registerPartial(fs.readFileSync(require.resolve('@economist/doc-pack/partials/component-tests.hbs')));
Handlebars.registerPartial(fs.readFileSync(require.resolve('@economist/doc-pack/partials/layout.hbs')));
Handlebars.registerPartial(fs.readFileSync(require.resolve('@economist/doc-pack/partials/panel.hbs')));

It also provides templates one can render:

Handlebars.render(fs.readFileSync(require.resolve('@economist/doc-pack/templates/index.hbs')));
Handlebars.render(fs.readFileSync(require.resolve('@economist/doc-pack/templates/standalone.hbs')));

Usage with hbs-cli

hbs-cli can also be very helpful for rendering these:

hbs --helper @economist/doc-pack --partial @economist/doc-pack/partials/* -- @economist/doc-pack/templates/index.hbs

Development Dependencies Requirements Latest Stable Latest Release Licenses
babel ^6.3.26 6.23.0 6.23.0 MIT
babel-cli ^6.8.0 6.24.1 7.0.0-alpha.9 MIT
babel-eslint ^6.0.4 7.2.3 7.2.3 MIT
babel-preset-es2015 ^6.3.13 6.24.1 7.0.0-alpha.9 MIT
babel-preset-es2015-loose ^7.0.0 8.0.0 8.0.0 MIT
babel-preset-stage-2 ^6.3.13 6.24.1 7.0.0-alpha.9 MIT
babel-runtime ^6.6.1 6.23.0 7.0.0-alpha.9 MIT
@economist/provision-react-component 1.7.4 3.1.0 3.1.0 MIT
eslint ~2.8.0 3.19.0 4.0.0-alpha.1 MIT
eslint-config-strict ^8.5.1 13.0.0 13.0.0 MIT
eslint-plugin-filenames ^0.2.0 1.2.0 1.2.0 MIT
ghooks ^1.2.1 2.0.0 2.0.0 MIT
npm-run-all ^1.8.0 4.0.2 4.0.2 MIT
semantic-release ^4.3.5 6.3.6 6.3.6 MIT
travis-after-all ^1.4.4 1.4.4 1.4.4 MIT
validate-commit-msg ^2.6.1 2.12.1 2.12.1 MIT
Explore the resolved development dependency tree for @economist/doc-pack 1.0.8
Dependencies Requirements Latest Stable Latest Release Licenses
debug ^2.2.0 2.6.4 2.6.4 MIT
handlebars-layouts ^3.1.3 3.1.4 3.1.4 MIT
helper-markdown ^0.2.1 0.2.1 0.2.1 MIT
helper-md ^0.1.0 0.2.2 0.2.2 MIT
helper-read ^0.1.0 0.1.0 0.1.0 MIT
helper-resolve ^0.3.1 0.3.1 0.3.1 MIT
highlight.js ^9.3.0 9.11.0 9.11.0 BSD-3-Clause
prismjs ^1.3.0 9000.0.1 9000.0.1 MIT
resolve ^1.1.7 1.3.3 1.3.3 MIT
Explore the resolved dependency tree for @economist/doc-pack 1.0.8

Releases

1.0.8 May 05, 2016
1.0.7 March 22, 2016
1.0.6 February 23, 2016
1.0.5 February 23, 2016
1.0.4 February 09, 2016
1.0.3 February 09, 2016
1.0.2 February 03, 2016
1.0.1 February 03, 2016
1.0.0 February 03, 2016

Project Statistics

SourceRank 15
Dependencies 9
Dependent projects 46
Dependent repositories 53
Total releases 9
Latest release
First release
Stars 0
Forks 3
Watchers 8
Contributors 8
Repo Size: 43 KB

Top Contributors See all

Keith Cirkel Greenkeeper Fábio Santos Daniel Umberto Andrew Martin Edoardo Colombo Angelo Repole

Something wrong with this page? Make a suggestion

Export .ABOUT file for this library

Last synced: 2017-01-05 10:42:40 UTC

Login to resync this project