@hopin/styleguide

A styleguide generation tool

Usage no npm install needed!

<script type="module">
  import hopinStyleguide from 'https://cdn.skypack.dev/@hopin/styleguide';
</script>

README

@hopin/styleguide

Travis Build Status Coverage Status

This is still early in development, but the idea is that it can generate a styleguide for "hopin theme".

An example of the output can be found at styleguide.gaunt.dev.

Toy Story Style

Building Styleguide for Theme

You can build the styleguide using the build command.

@hopin/styleguide build --dir <Path to Theme>

Developing Theme

You can use the serve command to watch and build your styleguide.

@hopin/styleguide serve --dir <Path to Theme>