{"_id":"gulp-mdox","_rev":"86-03752003fd3eaf3e756bcb9296803d75","name":"gulp-mdox","dist-tags":{"latest":"0.0.2"},"versions":{"0.0.1":{"name":"gulp-mdox","version":"0.0.1","keywords":["gulp","markdown","documentation","api"],"author":{"name":"Ryan Roemer","email":"ryan.roemer@formidablelabs.com"},"license":"MIT","_id":"gulp-mdox@0.0.1","maintainers":[{"name":"ryan.roemer","email":"ryan@loose-bits.com"}],"homepage":"https://github.com/FormidableLabs/gulp-mdox","bugs":{"url":"https://github.com/FormidableLabs/gulp-mdox/issues"},"dist":{"shasum":"fe230300e698fd5f5e04ddfca22cff278a365b57","tarball":"https://registry.npmjs.org/gulp-mdox/-/gulp-mdox-0.0.1.tgz","integrity":"sha512-Dr9RVJbv2HM90Gk1I3WUcVfo73JzwWzRWtnWdXEbNGqvtPG6xt1Cura7l6mkhWt39G5nDvguTNRWn7B3yvrBuA==","signatures":[{"sig":"MEUCIQCYxOYrM5PkmT9CdsGwfcfnEbpQ7aCmQnm1QYqD28VPnAIgd8FYnowedyDm5CbRxa02ongCYVLiHmqzqJE0OUrSS2w=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}]},"main":"mdox.js","_from":".","scripts":{"test":"gulp check"},"_npmUser":{"name":"ryan.roemer","email":"ryan@loose-bits.com"},"repository":{"url":"https://github.com/FormidableLabs/gulp-mdox","type":"git"},"_npmVersion":"1.4.3","description":"Convert and insert Markdown from JavaScript sources","directories":{},"dependencies":{"dox":"0.4.4","ejs":"1.0.0","lodash":"2.4.1","gulp-util":"2.2.14","event-stream":"3.1.4"},"devDependencies":{"chai":"1.9.1","gulp":"3.6.2","gulp-mocha":"0.4.1","gulp-jshint":"1.5.5"}},"0.0.2":{"name":"gulp-mdox","version":"0.0.2","keywords":["gulp","markdown","documentation","api"],"author":{"name":"Ryan Roemer","email":"ryan.roemer@formidablelabs.com"},"license":"MIT","_id":"gulp-mdox@0.0.2","maintainers":[{"name":"ryan.roemer","email":"ryan@loose-bits.com"}],"homepage":"https://github.com/FormidableLabs/gulp-mdox","bugs":{"url":"https://github.com/FormidableLabs/gulp-mdox/issues"},"dist":{"shasum":"28b91918e85a4e153ad6fabbe4609bdd378e5201","tarball":"https://registry.npmjs.org/gulp-mdox/-/gulp-mdox-0.0.2.tgz","integrity":"sha512-mzVYBsvQvH3+gN3EcQaFUwj3sn0CI+zJVPeJ+SJu7kxOF+hPC2BDclWAto1zllvqbM4GOwij9zLnMTyzd8J+2A==","signatures":[{"sig":"MEQCIH1FCDfO0UeFkWUtt/qZKQp1Lo9EuttG87bS3mGYHaWNAiAzszlhqbwIz5P5XFxMq+dD2nu1KYlRRF/JdsGBuWW+VQ==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}]},"main":"mdox.js","_from":".","scripts":{"test":"gulp check"},"_npmUser":{"name":"ryan.roemer","email":"ryan@loose-bits.com"},"repository":{"url":"https://github.com/FormidableLabs/gulp-mdox","type":"git"},"_npmVersion":"1.4.3","description":"Convert and insert Markdown from JavaScript sources","directories":{},"dependencies":{"dox":"0.4.4","ejs":"1.0.0","lodash":"2.4.1","gulp-util":"2.2.14","event-stream":"3.1.4"},"devDependencies":{"chai":"1.9.1","gulp":"3.6.2","gulp-mocha":"0.4.1","gulp-jshint":"1.5.5"}}},"time":{"created":"2014-04-29T00:51:24.020Z","modified":"2026-07-20T21:16:41.909Z","0.0.1":"2014-04-29T00:51:24.020Z","0.0.2":"2014-04-29T01:00:17.159Z"},"bugs":{"url":"https://github.com/FormidableLabs/gulp-mdox/issues"},"author":{"name":"Ryan Roemer","email":"ryan.roemer@formidablelabs.com"},"license":"MIT","homepage":"https://github.com/FormidableLabs/gulp-mdox","keywords":["gulp","markdown","documentation","api"],"repository":{"url":"https://github.com/FormidableLabs/gulp-mdox","type":"git"},"description":"Convert and insert Markdown from JavaScript sources","maintainers":[{"email":"sarahmichelleegan@gmail.com","name":"sarmeyer"},{"email":"mariano.martinez@formidable.com","name":"mariano-formidable"},{"email":"ryan@loose-bits.com","name":"ryan.roemer"},{"email":"admin@formidablelabs.com","name":"formidable-owner"},{"email":"npm@formidablelabs.com","name":"formidablelabs"},{"email":"sarah.wright@formidable.com","name":"sarahformidable"},{"email":"senesealessandro@gmail.com","name":"ceceppa"}],"readme":"# [gulp](https://github.com/gulpjs/gulp)-mdox [![Build Status](https://secure.travis-ci.org/FormidableLabs/gulp-mdox.png?branch=master)](http://travis-ci.org/FormidableLabs/gulp-mdox)\n\n> Convert JsDoc comments to Markdown.\n\n## Install\n\nInstall with [npm](https://npmjs.org/package/gulp-mdox)\n\n```\nnpm install --save-dev gulp-mdox\n```\n\n## Example\n\nThe JS source for `gulp-mdox` is read, converted to Markdown, and then inserted\ninto this [README.md](./README.md) document, overwriting the text sections\nfrom `## API` to `## Other Tools`.\n\n```js\nvar gulp = require(\"gulp\"),\n  mdox = require(\"gulp-mdox\");\n\ngulp.task(\"docs\", function () {\n  gulp\n    .src(\"mdox.js\")\n    .pipe(mdox({\n      src: \"./README.md\",\n      name: \"README.md\",\n      start: \"## API\",\n      end: \"## Other Tools\"\n    }))\n    .pipe(gulp.dest(\"./\"));\n});\n```\n\nWe eat our dog food!\n\nNote that you don't actually need the `src`, `start` and `end` parameters if\nall you want to do is generate a new / completely overwrite an existing\nfile.\n\n## API\n\n* [`exports(opts)`](#exportsopts)\n\n### `exports(opts)`\n* **opts** (`Object`) Options\n* **opts.name** (`String`) Output file name.\n* **opts.src** (`String`) Input source markdown file. (_optional_)\n* **opts.start** (`String`) Start marker. (_optional_)\n* **opts.end** (`String`) End marker. (_optional_)\n* **opts.github** (`Boolean`) Use GitHub headings? (_optional_)\n\nJsDoc-to-Markdown plugin.\n\nExtract JsDoc comments and convert to Markdown.\n\n## Other Tools\n\nOther alternative tools:\n\n* [gulp-markdox](https://github.com/gberger/gulp-markdox):\n  [markdox](https://github.com/cbou/markdox) plugin for gulp\n","readmeFilename":"README.md"}