Lora Styleguide

Aigis is a Node.js package that parses comments in your CSS and auto-generate a style guide.

See the Full-documents pxgrid.github.io/aigis/docs (This documents was generated by aigis. 🔗source

This is a fork that adds more features.

• New UI
• Extract Core layout (index, sidemenu, component)

Installation

$ npm install --save-dev lora-styleguide

You can verify lora-styleguide was installed correctly by running:

$ ./node_modules/.bin/aigis -v
$ 1.x.x

Config file & HTML Templates

aigis require "Config file" & "HTML Templates". This will create an styleguide.yml file (more on this below)

$ ./node_modules/.bin/aigis init
Created the following files and directories:
  styleguide.yml
  styleguide-templates
  

Config file

After aigis init, edit styleguide.yml. You have to write relative path to your source files on source.

source:
  - ./sass

Adding comments

Write following code on CSS comment block (/* ~ */)

It's easy to add Comments. For example.

---
name: base button
category: module/button
---

## This is base button

* Base button style.
* Use `a` or `button` tag.

```html
{{include './components/button' type='secondary' label='submit' }}
```

Running aigis

You're finally ready to generate a style guide!

$ ./node_modules/.bin/aigis run -c ./styleguide.yml

Then you get following output.

Submit

More

See the documents