compdoc

Turn html and css strings into documentation.

Work in progress

This library is currently under active development so things may change drastically. Though feedback and thoughts are encouraged, please open an issue!

What's this?

compdoc seeks to make building documentation for components easier. Currently, it accepts html, css (application level), and other metadata. It returns only the css used by the component, cssstats, color palette (with all accessible combinations).

TODO

• return typescale (if applicable)
• handle different states (warning, success, info, etc)
• integrate with react components, too?
• handle the description

Installation

npm install --save compdoc

Usage

const compdoc = require('compdoc')

const html = `
  <h1 class="purple">
    Hello, world!
  </h1>
`

const css = `
  .purple { color: purple; }
  .green { color: green; }
  .other-classes { /* ... */ }
`

const description = `
  This is an example component. This description text
  is written as markdown, and converted to html! _Neat_.
`

compdoc('Hello world component', { html, css, description })
  .then(console.log)

License

MIT

Contributing

1. Fork it
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create new Pull Request

Crafted with <3 by John Otander (@4lpine).

This package was initially generated with yeoman and the p generator.