{"_id":"@cxl/docma","_rev":"3-1f853eef71c91fe1fbdbbb6c914a9664","name":"@cxl/docma","description":"A documentation generation tool for Javascript","dist-tags":{"latest":"0.1.1"},"versions":{"0.1.1":{"name":"@cxl/docma","version":"0.1.1","description":"A documentation generation tool for Javascript","dependencies":{"@cxl/cxl":"*"},"files":["build","bin/docma.js","themes"],"main":"docma.js","bin":{"docma":"bin/docma.js"},"license":"GPL-3.0","devDependencies":{"grunt":"*","lodash":"*","grunt-contrib-jshint":"*","grunt-contrib-clean":"*","grunt-contrib-concat":"*","grunt-contrib-watch":"*","grunt-contrib-uglify":"*","@cxl/inference":"*","highlight.js":"*"},"gitHead":"f49e091ebc2e14417c624b9ea7cc4271afd63438","_id":"@cxl/docma@0.1.1","scripts":{},"_shasum":"e15dc288a9f4020f1db1349df426312fd751cc25","_from":".","_npmVersion":"3.8.3","_nodeVersion":"5.10.1","_npmUser":{"name":"cxl","email":"giancarlo@coaxialhost.com"},"dist":{"shasum":"e15dc288a9f4020f1db1349df426312fd751cc25","tarball":"https://registry.npmjs.org/@cxl/docma/-/docma-0.1.1.tgz","integrity":"sha512-V7ERavU0UWZOG3CH4dGuKQ9V551lTrtg8zkpVkQ2JC+LGIhOMr0r4BlrA5YvqEkhR4CB9jz6agYTNOti3DX8mw==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDTzTiGmS5DBM81ZJCCdZDwe+wPQZFkOxluQjHiGfrKwwIgTDZjxupJjzydb1J3Kz/VHynJlCsjfr8A3ZmWj+e0Qrg="}]},"maintainers":[{"name":"cxl","email":"giancarlo@coaxialhost.com"}],"_npmOperationalInternal":{"host":"packages-12-west.internal.npmjs.com","tmp":"tmp/docma-0.1.1.tgz_1464613061310_0.4709238144569099"}}},"readme":"docma.js\n========\n\nJavascript documentation tool. Uses esprima for parsing and a custom\ntype inference(https://github.com/j5g3/inference) engine for analysis.\nIt supports JSDOC style comments using\nj5g3.jsdoc-parser(https://github.com/j5g3/jsdoc-parser). \n\nThe engine is fast, and can be used to render documentation on the fly.\n\nSupported tags:\n\n- abstract, virtual\n- alias\n- author\n- augments, extends\n- callback\n- class, constructor, constructs\n- const, constant\n- copyright\n- deprecated\n- desc\n- event\n- extends\n- file\n- global\n- ignore\n- lends, scope\n- license\n- method, property, mixin\n- namespace\n- param\n- private, protected, public\n- readonly\n- requires, returns\n- static\n- this\n- throws\n- todo\n- version\n\nInstallation/Build\n------------------\n\nDownload/Clone the repository and then run these commands in the root folder.\n\n\tnpm install\n\tgrunt\n\nDemo\n----\n\n[docs/index.html](http://j5g3.github.io/docma/docs)\n\tLive documentation rendering.\n\t\n\t\nCommand Line Tool\n-----------------\n\nbin/docma.js\n\nUsage: docma [options] sources.js+\n\nOptions:\n\n\t-n --name docname          String to use as title of documentation page.\n\t-t --template template     Underscore template file to use.\n\nWill output HTML to standard output. Requires node.js.","maintainers":[{"name":"cxl","email":"giancarlo@coaxialhost.com"}],"time":{"modified":"2022-06-12T16:50:19.966Z","created":"2016-05-30T12:57:43.914Z","0.1.1":"2016-05-30T12:57:43.914Z"},"license":"GPL-3.0","readmeFilename":"README.md"}