live-guide

live-guide

THIS IS VERY MUCH UNDER DEVELOPMENT, API IS SURE TO CHANGE

Use as module:

const styleguide = require('live-guide');
const options = {
    input: "src/**/*.css",
    resources: ['path/to/compiled/style.css', 'path/to/other/required/files/app.js']
};

styleguide(options)
    .then(function(data) {
        // Do something after styleguide is compiled.
        // data refers to an array of objects containing all the relevant data from your build
    });

Use in command line:

$ npm install --global live-guide
$ live-guide --input="path/to/**/*.css" --output=/var/www/styleguide --resource path/to/style.css another/path/here.js

Module API

@author: Contribute the code to someone

pattern: /@author[^\S\n]+?(.+)/g

@description: Set a description for this section of the styleguide, generally used after an @title

pattern: /@description[^\S\n]+?(.+)/g

@example: A code example, similar to writing ``` in Markdown

pattern: /^@example(.*?)?$\s((?:^.+$\s?)+)/gm

@title: The title of the component, module or API you are developing

pattern: /^@title (.*)$/gm

@todo: Let users know what needs to be done in this section of your style guide

pattern: /^@(?:todo|task) (.*)$/gm

@url: Add a link to the styleguide, automatically opens in a new tab

pattern: /@url[^\S\n]+?(.+)/g

@wrietName: If you want the file name to be different than the title, for instance setting up an index page. There is no need to provide a file extension

pattern: /@writeName(.+)/g

---

TODO

[ ] Log whats happening.

[ ] Internal Modules 1. write-html - use all async solutions

[ ] Handlebars

1. helpers
   • resource allow HTTP/S resources.