{"_id":"mdextract","_rev":"6-8800841fb6c9658daeea46003670b4f7","name":"mdextract","description":"Extracts `/** code comments */` from code files and turns them into markdown docs. Supports JavaScript-style comments (other languages to come).","dist-tags":{"latest":"1.0.0"},"versions":{"0.1.0":{"name":"mdextract","description":"Extracts `/** code comments */` from code files and turns them into markdown docs. Supports JavaScript-style comments (other languages to come).","keywords":[],"author":{"name":"Rico Sta. Cruz","email":"hi@ricostacruz.com"},"version":"0.1.0","repository":{"type":"git","url":"https://github.com/rstacruz/mdextract.git"},"main":"index","scripts":{"test":"mocha"},"devDependencies":{"mocha":"^1.18.2","chai":"^1.9.1","coffee-script":"^1.7.1","sinon":"^1.9.0"},"bin":{"mdextract":"./bin/mdextract"},"license":"MIT","dependencies":{"nopt":"^2.2.1"},"gitHead":"a36e681d77b4aab566d071be078d1a9ad7466a0e","bugs":{"url":"https://github.com/rstacruz/mdextract/issues"},"homepage":"https://github.com/rstacruz/mdextract","_id":"mdextract@0.1.0","_shasum":"ab1dc862c5bef0ec51fef9178e7b23c2e3733ffd","_from":".","_npmVersion":"1.4.16","_npmUser":{"name":"rstacruz","email":"rico@ricostacruz.com"},"maintainers":[{"name":"rstacruz","email":"rico@ricostacruz.com"}],"dist":{"shasum":"ab1dc862c5bef0ec51fef9178e7b23c2e3733ffd","tarball":"https://registry.npmjs.org/mdextract/-/mdextract-0.1.0.tgz","integrity":"sha512-zrUIVD2eiU6qIENCv37AmgCZopLg95dL+Ym1uiJtbKFPjkwi2Lj1r8KNFGRdahmTyVqa/Dd89qMC0l8yysX6SA==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDbLrjDvBTiLfeZTAehtbRTtxzzxSrICYK2YNyIuDwAlAIhAKrLrrpB6lmXoG7eaPfWXJQ2/9qa+ZfGQK+Ngm+KW2MU"}]}},"1.0.0":{"name":"mdextract","description":"Extracts `/** code comments */` from code files and turns them into markdown docs. Supports JavaScript-style comments (other languages to come).","keywords":[],"author":{"name":"Rico Sta. Cruz","email":"hi@ricostacruz.com"},"version":"1.0.0","repository":{"type":"git","url":"https://github.com/rstacruz/mdextract.git"},"main":"index","scripts":{"test":"mocha"},"devDependencies":{"mocha":"^1.18.2","chai":"^1.9.1","coffee-script":"^1.7.1","sinon":"^1.9.0"},"bin":{"mdextract":"./bin/mdextract"},"license":"MIT","dependencies":{"nopt":"^2.2.1"},"gitHead":"f7d3e4401e3083d705e10e41e7a4fcbd11b7b3b2","bugs":{"url":"https://github.com/rstacruz/mdextract/issues"},"homepage":"https://github.com/rstacruz/mdextract","_id":"mdextract@1.0.0","_shasum":"028c0c9105506b2beadcd7d96cdbec6eaf9b4176","_from":".","_npmVersion":"1.4.16","_npmUser":{"name":"rstacruz","email":"rico@ricostacruz.com"},"maintainers":[{"name":"rstacruz","email":"rico@ricostacruz.com"}],"dist":{"shasum":"028c0c9105506b2beadcd7d96cdbec6eaf9b4176","tarball":"https://registry.npmjs.org/mdextract/-/mdextract-1.0.0.tgz","integrity":"sha512-iG+MTf5NooA7lkX8m7yyyGV3+aJIDFphchFpHDIgEAtpgdSmYBUPb77ILIfqHZIvq4iSK/WtxRqemgr17W1gxg==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCrFjYAm0w0OHz7HhNRXdcRAtlHt/pVZQ8qY7tmTis2oQIgFdcZMYzbCQnKDflPdbXeOE2s9v8cClsDmahyAM0pWq8="}]}}},"readme":"# mdextract\n\nExtracts `/** code comments */` from code files and turns them into markdown \ndocs. Supports JavaScript-style comments (other languages to come).\n\n $ npm install -g mdextract\n $ mdextract --help\n\nUse it to extract comments into a doc:\n\n $ mdextract file.js > docs.md\n\nOr update a doc:\n\n $ cat README.md\n\n add `include` comments to your markdown file\n\n \n \n\n $ mdextract --update README.md\n\n...the `--update` mode is great for making Readme-based documentation in small \nprojects. It is [idempotent].\n\nFile format\n-----------\n\n__Sections:__ mark them with comments beginning with two stars.\n\n```\n/**\n * Sections:\n * Start your sections with two stars.\n *\n * If your first line of text ends in a colon (:), it will be turned into an\n * `

` heading.\n */\n```\n\n__Main sections:__ three stars.\n\n```\n/***\n * Main sections:\n * If you start sections with three stars, the headings will be turned into\n * `

` headings.\n */\n```\n\n__Code blocks:__ They will be converted into syntax-highlighted code fences.\n\n```\n/**\n * An example:\n *\n * function () {\n * return true;\n * }\n */\n```\n\n__Definition lists:__ Use `~` as a bullet. Great for parameter lists.\n\n```\n/**\n * ~ name: description\n * ~ id: the identifier\n * ~ callback (Function): the callback to run afterwards\n */\n```\n\n__Sample usage:__ Use `name : usage` as your first line to specify a sample \nusage.\n\n```\n/**\n * push : push(name, fn)\n * Adds an item to the stack.\n */\n```\n\n__Single-line mode:__ for short documentations.\n\n```js\n/** id: the identifier. */\nthis.id = null;\n\n/** name: the name. */\nthis.name = \"Hello\";\n```\n\nExamples\n--------\n\n * [index.js](index.js) from mdextract ([output](API.md))\n * [navstack.js] from Navstack ([output][navstack-out])\n\n[navstack.js]: https://github.com/rstacruz/navstack/blob/master/navstack.js\n[navstack-out]: https://github.com/rstacruz/navstack/blob/master/Readme.md\n\nThanks\n------\n\n**mdextract** © 2014+, Rico Sta. Cruz. Released under the [MIT License].
\nAuthored and maintained by Rico Sta. Cruz with help from [contributors].\n\n> [ricostacruz.com](http://ricostacruz.com)  · \n> GitHub [@rstacruz](https://github.com/rstacruz)  · \n> Twitter [@rstacruz](https://twitter.com/rstacruz)\n\n[MIT License]: http://mit-license.org/\n[contributors]: http://github.com/rstacruz/mdextract/contributors\n[idempotent]: https://en.wikipedia.org/wiki/Idempotent\n","maintainers":[{"name":"rstacruz","email":"rico@ricostacruz.com"}],"time":{"modified":"2022-06-19T17:18:47.933Z","created":"2014-07-14T03:17:43.056Z","0.1.0":"2014-07-14T03:17:43.056Z","1.0.0":"2014-07-15T08:08:11.639Z"},"homepage":"https://github.com/rstacruz/mdextract","keywords":[],"repository":{"type":"git","url":"https://github.com/rstacruz/mdextract.git"},"author":{"name":"Rico Sta. Cruz","email":"hi@ricostacruz.com"},"bugs":{"url":"https://github.com/rstacruz/mdextract/issues"},"license":"MIT","readmeFilename":"Readme.md"}