© 2017, Onur Yıldırım (@onury). MIT License.
No need for this grunt task anymore. Since Docma has a CLI; you can simply add Docma to your
scripts section in your
"scripts":"docs": "docma -c ./docma.config.json"// your other scripts
npm run docs
If 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:
npm i grunt-docma --save-dev
Run this task with the
grunt docma command.
Task targets and options may be specified according to the grunt Configuring tasks guide.
||(Default Config)||Either a Docma configuration object, or a path to a Docma config file. See build configuration and default template options.|
On a fatal error (i.e.
Note that, if you set
config option to a config-file path, you can also define
dest within that configuration file. But if you additionally define these within the task configuration, it will be used instead.
CAUTION: Destination directory (
dest) will be emptied before the build. Make sure you set
dest to a correct path.