arbus / grunt-aglio Goto Github PK
View Code? Open in Web Editor NEWGrunt plugin to generate aglio documentation
License: MIT License
Grunt plugin to generate aglio documentation
License: MIT License
New aglio version
Would be useful for automatically adding in version numbers etc in a build step
How do you specify flags like --full-width and --no-condense to aglio task options
nvm current // system - v0.10.30
grunt aglio:apiManual // Works
``
Trying with 0.12:
nvm use 0.12.7 // Now using node v0.12.7 (npm v2.11.3)
sudo rm -rf node_modules/
sudo npm i
grunt aglio:apiManual
Loading "aglio.js" tasks...ERROR
Error: Module did not self-register.
Warning: Task "aglio:apiManual" not found. Use --force to continue.
Aborted due to warnings.
I am using
"grunt-available-tasks": "^0.6.0"
and
"grunt-aglio": "^0.4.0",
Please update to aglio 2.0.4
require loDash instead
Any plans of incorporation this feature:
aglio -t flatly-multi --full-width -i Docs/Blueprint.md -s
Basically provide an option to render the blueprint to the browser.
[root@VM_11_225_centos grunt-aglio-0.4.1]# npm install grunt-aglio --save-dev
npm ERR! Linux 3.10.0-229.el7.x86_64
npm ERR! argv "/usr/local/bin/node" "/usr/local/bin/npm" "install" "grunt-aglio" "--save-dev"
npm ERR! node v6.2.1
npm ERR! npm v3.9.3
npm ERR! code ENOSELF
npm ERR! Refusing to install grunt-aglio as a dependency of itself
npm ERR!
npm ERR! If you need help, you may report this error at:
npm ERR! https://github.com/npm/npm/issues
npm ERR! Please include the following file with any support request:
npm ERR! /root/grunt-aglio-0.4.1/npm-debug.log
[root@VM_11_225_centos grunt-aglio-0.4.1]#
Grunt tasks options should not be at the same level of files / src.
Grunt also have a helper to get per target options with fallback to default, see http://gruntjs.com/api/inside-tasks#this.options
Instead of
grunt.initConfig({
aglio: {
your_target:{
files:{
"dest/api.html": ["src/docs/section1.md", "src/docs/section2.md"]
},
theme: "default",
seperator: "\n"
}
},
})
you should have
grunt.initConfig({
aglio: {
your_target:{
files:{
"dest/api.html": ["src/docs/section1.md", "src/docs/section2.md"]
},
options: {
theme: "default",
seperator: "\n"
}
}
},
})
So options will work in target or at global level for all target. see http://gruntjs.com/configuring-tasks#options
It seems nothing else needed that updating the peerDependencies
from "grunt": "~0.4.1"
to "grunt": ">=0.4.1"
It will be nice to be able to filter the output, after call to aglio, like we can filter the input.
Move all aglio specific options into aglioOptions to be more resilient to aglio updates and separate aglio options from task options.
aglio 2.1.1 brings compatibility with Node 4.x as they've updated protagonist to version 1.1.0. Refer to danielgtaylor/aglio#172.
Example:
Running "aglio:api" (aglio) task
>> Written to docs-dist/api/counter_details.html
>> Written to docs-dist/api/observation_details.html
>> Written to docs-dist/api/api.html
Running "aglio:internal" (aglio) task
Running "aglio:guides" (aglio) task
If I run the additional tasks separately, they compile file. If I just run the grunt aglio
task, then no files are written for the additional tasks.
A declarative, efficient, and flexible JavaScript library for building user interfaces.
๐ Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. ๐๐๐
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google โค๏ธ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.