grunt-groc
Advanced tools
A simple grunt task to generate a project's documentation using Groc
Groc depends on Pygments to generate documentation. Follow the installation instructions here.
Install this plugin with the following command:
npm install grunt-groc --save-dev
Load the plugin in your Gruntfile.js:
grunt.loadNpmTasks('grunt-groc');
Running grunt groc:javascript (or grunt groc since groc is a multitask) will generate documentation for the specified files.
// Project configuration.
grunt.initConfig({
groc: {
javascript: [
"tasks/*.js", "README.md"
],
options: {
"out": "doc/"
}
}
});
See Groc's cli for all available options
FAQs
Generate documentation using groc
The npm package grunt-groc receives a total of 143 weekly downloads. As such, grunt-groc popularity was classified as not popular.
We found that grunt-groc demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Deno 2.2 enhances Node.js compatibility, improves dependency management, adds OpenTelemetry support, and expands linting and task automation for developers.
Security News
React's CRA deprecation announcement sparked community criticism over framework recommendations, leading to quick updates acknowledging build tools like Vite as valid alternatives.
Security News
Ransomware payment rates hit an all-time low in 2024 as law enforcement crackdowns, stronger defenses, and shifting policies make attacks riskier and less profitable.