https://github.com/frontainer/grunt-frontnote

スタイルガイドジェネレーターFrontNoteのGruntプラグイン
https://github.com/frontainer/grunt-frontnote

css frontnote grunt sass scss styleguide stylus

Last synced: about 7 hours ago
JSON representation

スタイルガイドジェネレーターFrontNoteのGruntプラグイン

• Host: GitHub
• URL: https://github.com/frontainer/grunt-frontnote
• Owner: frontainer
• License: mit
• Created: 2014-08-14T14:17:14.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2016-10-08T02:34:30.000Z (over 8 years ago)
• Last Synced: 2025-01-18T01:35:21.384Z (19 days ago)
• Topics: css, frontnote, grunt, sass, scss, styleguide, stylus
• Language: JavaScript
• Homepage:
• Size: 12.7 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# grunt-frontnote

> StyleGuide Generator [FrontNote](https://github.com/frontainer/frontnote)  Plugin for Grunt.

## Getting Started

This plugin requires 

* [Grunt](http://gruntjs.com/) `~0.4.5`

If you haven't used [Grunt](http://gruntjs.com/) before, be sure to check out the [Getting Started](http://gruntjs.com/getting-started) guide, as it explains how to create a [Gruntfile](http://gruntjs.com/sample-gruntfile) as well as install and use Grunt plugins. 

Once you're familiar with that process, you may install this plugin with this command:

```js

grunt.loadNpmTasks('grunt-frontnote');

```

## The "frontNote" task

### Overview

In your project's Gruntfile, add a section named `frontNote` to the data object passed into `grunt.initConfig()`.

```js

grunt.initConfig({

  frontNote: {

    options: {

      // Task-specific options go here.

    },

    your_target: {

      files: [

        // Target files path.

      ]

      // Target-specific file lists and/or options go here.

    },

  },

});

```

### Options

Options supported by [frontnote](https://github.com/frontainer/frontnote)

### Usage Examples

	frontNote: {

	    options: {

	        out: './doc',

	        template: './my-template',

	        overview: './overview.md',

	        includePath: 'assets/**/*'

	    },

	    dev: {

	        options: {

	        },

	        files: [

	            '/path/to/**/*.css',

	            '/path/to/**/*.sass',

	            '/path/to/**/*.less'

	        ]

	    }

	}