Git Product home page Git Product logo

gulp-raddoc's Introduction

Rad Doc

A CSS documentation tool.

Installation

npm install gulp-raddoc --save-dev

Usage

Rad Doc generates a HTML page based on CSS comments at the top of your CSS/Less/SASS files.

Comments must be at the top of the component file and begin with /* and end with */. The comments themselves should follow a markdown format. For example:

/*

# Alert

An alert to display information to users
    
### Modifiers

- .Alert--info - used for information alerts 
- .Alert--success - used for success alerts 
- .Alert--error - used for error alerts  
             
### Example

    <div class="Alert Alert--info">This is an info alert</div>    
    <div class="Alert Alert--success">This is a success alert</div> 
    <div class="Alert Alert--error">This is an error alert</div>      
     
*/

Here is an example gulp task.

gulp.task('raddoc', function () {
    return gulp.src('css/components/**/*') // point this at the files that you want to document
        .pipe(raddoc({
            css: '../assets/css/main.css', // your styles
            outputFolder: '_build/' // where you want rad doc to live
        }))
});

gulp-raddoc's People

Contributors

mattbegent avatar

Watchers

James Cloos avatar  avatar Glenn Flanagan avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.