Frontnote

Node.jsを使ったスタイルガイドジェネレータ

This project is maintained by frontainer

Node.js StyleGuide Generator

Frontnote

FrontnoteはNode.js製のスタイルガイドジェネレータです。

npm install frontnote --save-dev

Frontnoteについて

このスタイルガイドジェネレーターはKSSをインスパイアして開発されたものです。
KSSと同様にトップページにはMarkdownファイルを読み込み表示します。
KSSにない機能としてスタイル全体の概要、カラーパレット、スタイルに任意のラベル付けを有しています。

公式にGulp.js/Grunt.jsのプラグインもあり、簡単にスタイルガイド作成を自動化することができます。

テンプレートはカスタマイズ可能

テンプレートエンジンにEJSを採用しています。
既存のテンプレートを修正するだけでオリジナルのデザインでスタイルガイドを作成できます。
テンプレートのリポジトリを参照ください。

※ テンプレート作成ガイド鋭意制作中・・・

For Gulp.js

Gulp.js用のプラグインです。
gulp-frontnote

npm install gulp-frontnote --save-dev

※ gulp-frontnoteにはfrontnoteが含まれているので別途インストールの必要はありません

For Grunt.js

Grunt.js用のプラグイン   grunt-frontnote

※ grunt-frontnoteにはfrontnoteが含まれているので別途インストールの必要はありません

License

The MIT License (MIT)

Copyright (c) 2014 Frontainer

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Author

frontainer

frontainer