documentation-stylist

documentation-stylist

documentation-stylist is a react-styleguidist-inspired theme for documentation.js with support for TypeScript and React components

Logo Style by Andre from NounProject.com

You can check an example documentation that uses it here: rlayers

Usage

First:

npm i --save-dev documentation-stylist

Then:

documentation build ... --theme=node_modules/documentation-stylist/index.js

Using with React Components

documentation-stylist supports the non-standard JSDoc tag @propsfor that allows to link the properties interface definition to the component.

Customization

documentation-stylist uses Bootstrap and Handlebars. Simply copy the documentation-stylist directory to your project and edit the templates in ./hbs.