Gruntfile tasks. These tasks are intended to help you when modifying the template. If you are just using the template, don't sweat this stuff. To use these tasks, you must install grunt, if you haven't already, and install the dependencies. All of this requires node.js, of course.
Install grunt:
npm install -g grunt-cliThen in the directory where you found this file:
npm installAnd you are all set. See the individual tasks for details.
requires
- module:path
- module:lodash
- module:http
- module:async
- module:fs
members
<static> apply
TASK: Applies the theme in the conf file and applies it to the styles directory.
<static> bootswatch
TASK: Grab all Bootswatch themes and create css from each one based on the main.less in the styles directory. NOTE that this will leave the last swatch downloaded in the styles directory, you will want to call "apply" afterwards
<static> build
TASK: Builds the whole shebang. Which means creating testdocs, the bootswatch fixtures and then resetting the styles directory.
<static> dev
Compile the CSS and create the project documentation
<static> docs
Builds the project's documentation
<static> examples
TASK:Create fixtures from the themes. The files must have been built first from the bootswatch task.
<static> less
TASK: The less task creates the themed css file from main.less. The file is written to the template styles directory as site.[name of theme].css. Later the .conf file will look for the theme to apply based on this naming convention.
<static> shell:dox
TASK: Create project documentation
<static> shell:testdocs
TASK: Create the a documentation set for testing changes to the template
<static> testdocs
TASK: Builds the main less file and then generates the test documents
methods
jsdocCommand(jsdoc)
Normalizes all paths from a JSDoc task definition and and returns an executable string that can be passed to the shell.
Parameters:
| Name | Type | Description |
|---|---|---|
jsdoc |
object | A JSDoc definition |
Returns:
- Type
- string