Grunt wrapper for styledoc: parser and showcase generator for JavaDoc-like comments in CSS, LESS, SASS etc.
npm install grunt-styledoc> Grunt wrapper for styledoc: parser and showcase generator for JavaDoc-like comments in CSS, LESS, SASS etc.
~0.4.5If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:
``shell`
npm install grunt-styledoc --save-dev
Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
`js`
grunt.loadNpmTasks('grunt-styledoc');
to the data object passed into grunt.initConfig().`js
grunt.initConfig({
styledoc: {
options: {
// Task-specific options go here.
},
your_target: {
// Target-specific file lists and/or options go here.
},
},
});
`$3
#### options.templates_dir
Type:
String
Default value: "Path to templates directory, relative to current location.
#### options.template
Type:
String
Default value: "default"Name of showcase page template.
#### options.language
Type:
String
Default value: "en"Language to apply when creating page (should exist in template's
languages directory)#### options.doctype
Type:
String
Default value: "html5"Live preview target doctype (should exist in template's
preview directory).#### options.page_title
Type:
String
Default value: ""Main title of document.
#### options.css_url_http
Type:
Sumber
Default value: undefinedHTTP(S) path to CSS file to use in live preview (detected automatically by default).
#### options.iframe_delay
Type:
Number
Default value: 2000Delay (ms) before refreshing iframe height.
This delay is needed to render preview item iframe page, measure its height, and then apply this height to