{"_id":"renderme","_rev":"31-a674d40b5417b1f956e1d42d47b9b835","name":"renderme","description":"Render README files from github","dist-tags":{"latest":"0.1.0"},"versions":{"0.0.1":{"name":"renderme","version":"0.0.1","description":"Render README files from github","main":"index.js","scripts":{"test":"mocha $(find test -name '*.test.js')"},"repository":{"type":"git","url":"https://github.com/3rd-Eden/renderme"},"keywords":["README","render","github"],"author":{"name":"Arnout Kazemier"},"license":"MIT","bugs":{"url":"https://github.com/3rd-Eden/renderme/issues"},"homepage":"https://github.com/3rd-Eden/renderme","dependencies":{"debug":"0.7.x","githulk":"0.0.x","marked":"0.3.x","pygmentize-bundled":"2.1.x","sanitizer":"0.1.x"},"devDependencies":{"chai":"1.9.x","mocha":"1.17.x","npmjs":"0.0.x","pre-commit":"0.0.x"},"_id":"renderme@0.0.1","dist":{"shasum":"b7af051866d1264bbb90e4e455547715f8a26496","tarball":"https://registry.npmjs.org/renderme/-/renderme-0.0.1.tgz","integrity":"sha512-nX8gVblzzvyrLhjZW19aEA6y+ZaJBBdc5PoWl0GqPyRee/A/4fHEVe9BF+zYyReHsciT9InHwV042cXTbbmAKg==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIGbZtQZ3xnzimlzMOQoFrLW/hzRtrGgdR8W76dznNq/gAiBbZ8woQ9mC9Okv/heag/yHVmNI1JcAeq891uqs3mC08A=="}]},"_from":".","_npmVersion":"1.3.21","_npmUser":{"name":"V1","email":"info@3rd-Eden.com"},"maintainers":[{"name":"V1","email":"info@3rd-Eden.com"}]},"0.0.2":{"name":"renderme","version":"0.0.2","description":"Render README files from github","main":"index.js","scripts":{"test":"mocha $(find test -name '*.test.js')"},"repository":{"type":"git","url":"https://github.com/3rd-Eden/renderme"},"keywords":["README","render","github"],"author":{"name":"Arnout Kazemier"},"license":"MIT","bugs":{"url":"https://github.com/3rd-Eden/renderme/issues"},"homepage":"https://github.com/3rd-Eden/renderme","dependencies":{"debug":"0.7.x","githulk":"0.0.x","marked":"0.3.x","pygmentize-bundled":"2.1.x","sanitizer":"0.1.x"},"devDependencies":{"chai":"1.9.x","mocha":"1.17.x","npmjs":"0.0.x","pre-commit":"0.0.x"},"_id":"renderme@0.0.2","dist":{"shasum":"7fd0d27967f38ca9a53a7f72bb0ffa4e51843562","tarball":"https://registry.npmjs.org/renderme/-/renderme-0.0.2.tgz","integrity":"sha512-S22ZNSbU9XKIV+EiPj6GLPkZekz1GIgxEJlJ7QM6fNjsWv2iRw3fDnVYtJsCcfJXux+9NUxEhR3dLdUvdAotOQ==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIFjcTLN1nwLqU6FWRrnNL1+ip2LfMAsUQ6QGMcPerdkzAiBqrOlNiCpsSaPgRdxBn+1CsH8iqmHs5yp9S5PaxNMsSw=="}]},"_from":".","_npmVersion":"1.3.21","_npmUser":{"name":"V1","email":"info@3rd-Eden.com"},"maintainers":[{"name":"V1","email":"info@3rd-Eden.com"}]},"0.0.3":{"name":"renderme","version":"0.0.3","description":"Render README files from github","main":"index.js","scripts":{"test":"mocha $(find test -name '*.test.js')"},"repository":{"type":"git","url":"https://github.com/3rd-Eden/renderme"},"keywords":["README","render","github"],"author":{"name":"Arnout Kazemier"},"license":"MIT","bugs":{"url":"https://github.com/3rd-Eden/renderme/issues"},"homepage":"https://github.com/3rd-Eden/renderme","dependencies":{"debug":"0.7.x","githulk":"0.0.x","marked":"0.3.x","pygmentize-bundled":"2.1.x","sanitizer":"0.1.x"},"devDependencies":{"chai":"1.9.x","mocha":"1.17.x","npmjs":"0.0.x","pre-commit":"0.0.x"},"_id":"renderme@0.0.3","dist":{"shasum":"2b0ca97c317a059cbe4de0e984bdbc6ed2d3a294","tarball":"https://registry.npmjs.org/renderme/-/renderme-0.0.3.tgz","integrity":"sha512-qhTCrsXXgyo6Fj9T1Mvc3gLk1v3Jib/VqURpzDnc8fymoduVmqa/kGge+v9SbFtk9VQkhAs9kA9niPnlHcZ2lw==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIGa9jJFpKLwANWdV3ev0LV1OnALZAJe1t5yth8ExZmgTAiEAjdT6rkqLvzm0YZ2afxxFTSvHS2QZ4WELIE9Tk94se8k="}]},"_from":".","_npmVersion":"1.3.21","_npmUser":{"name":"V1","email":"info@3rd-Eden.com"},"maintainers":[{"name":"V1","email":"info@3rd-Eden.com"}]},"0.0.4":{"name":"renderme","version":"0.0.4","description":"Render README files from github","main":"index.js","scripts":{"test":"mocha $(find test -name '*.test.js')"},"repository":{"type":"git","url":"https://github.com/3rd-Eden/renderme"},"keywords":["README","render","github"],"author":{"name":"Arnout Kazemier"},"license":"MIT","bugs":{"url":"https://github.com/3rd-Eden/renderme/issues"},"homepage":"https://github.com/3rd-Eden/renderme","dependencies":{"debug":"0.7.x","githulk":"0.0.x","marked":"0.3.x","pygmentize-bundled":"2.1.x","sanitizer":"0.1.x"},"devDependencies":{"chai":"1.9.x","mocha":"1.17.x","npmjs":"0.0.x","pre-commit":"0.0.x"},"_id":"renderme@0.0.4","dist":{"shasum":"dd1e4967941a01f5b3faab4adee1a102a886e3e8","tarball":"https://registry.npmjs.org/renderme/-/renderme-0.0.4.tgz","integrity":"sha512-8B7L4eedGzUxNHOykQhARDbyJuYCFEnESJShMsyT/k+zjkbDfqp3FBKBYWpZWYYDqrG/kJs4KiJOIvUH8eJQxw==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIBOIXHjusa+PX5/c8FXWRgc4kfC2hQ3O5yZb/UxQ6qokAiEA3c4Z3+D9nhp9zYnLmPoAFz+KncTqnM26S9MY5g6IjW0="}]},"_from":".","_npmVersion":"1.3.21","_npmUser":{"name":"V1","email":"info@3rd-Eden.com"},"maintainers":[{"name":"V1","email":"info@3rd-Eden.com"}]},"0.0.5":{"name":"renderme","version":"0.0.5","description":"Render README files from github","main":"index.js","scripts":{"test":"mocha $(find test -name '*.test.js')"},"repository":{"type":"git","url":"https://github.com/3rd-Eden/renderme"},"keywords":["README","render","github"],"author":{"name":"Arnout Kazemier"},"license":"MIT","bugs":{"url":"https://github.com/3rd-Eden/renderme/issues"},"homepage":"https://github.com/3rd-Eden/renderme","dependencies":{"debug":"0.7.x","githulk":"0.0.x","marked":"0.3.x","pygmentize-bundled":"2.1.x","sanitizer":"0.1.x"},"devDependencies":{"chai":"1.9.x","mocha":"1.17.x","npmjs":"0.0.x","pre-commit":"0.0.x"},"_id":"renderme@0.0.5","dist":{"shasum":"1d315d4793a2d46fd51cd22fe43ef3960bcf4cce","tarball":"https://registry.npmjs.org/renderme/-/renderme-0.0.5.tgz","integrity":"sha512-inV5utVGSf1Y0HGcqIgotfuv9vSaOl1MXpzV1YOZOW7Q1uQ37JtF9tFyb4jj9G5fMqhRUCvJ6qeibUnTzI4lZg==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDlKVTueRwvPwzZPZ6rPU19NSzsNRG1rR42ltLS0+BbSwIgdMYkMTWspXMYKKl/T4ah7H4u6EELoq2YY0ZgKhrXWh8="}]},"_from":".","_npmVersion":"1.3.21","_npmUser":{"name":"V1","email":"info@3rd-Eden.com"},"maintainers":[{"name":"V1","email":"info@3rd-Eden.com"}]},"0.0.6":{"name":"renderme","version":"0.0.6","description":"Render README files from github","main":"index.js","scripts":{"test":"mocha $(find test -name '*.test.js')"},"repository":{"type":"git","url":"https://github.com/3rd-Eden/renderme"},"keywords":["README","render","github"],"author":{"name":"Arnout Kazemier"},"license":"MIT","bugs":{"url":"https://github.com/3rd-Eden/renderme/issues"},"homepage":"https://github.com/3rd-Eden/renderme","dependencies":{"debug":"0.7.x","githulk":"0.0.x","marked":"0.3.x","pygmentize-bundled":"2.1.x","sanitizer":"0.1.x"},"devDependencies":{"chai":"1.9.x","mocha":"1.17.x","npmjs":"0.0.x","pre-commit":"0.0.x"},"_id":"renderme@0.0.6","dist":{"shasum":"512802865e1a8ab38a9e2221a96e791691678dbb","tarball":"https://registry.npmjs.org/renderme/-/renderme-0.0.6.tgz","integrity":"sha512-hqoqXWzSwBwe/JZq8QkPpBxgu+o646LGuHjBlqIDMIT+42z6h0HoLI0bCli7CyILjA+N623M/jMMJDWIEA923w==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQD2SsFraiIKbObluOl70sOd6jpkiWT/Tk5wv1+4jNsNtAIgdAxRd7afFMDnrT/RF7ouj/tJYuXGbIxCJZNvJzCxI94="}]},"_from":".","_npmVersion":"1.3.21","_npmUser":{"name":"V1","email":"info@3rd-Eden.com"},"maintainers":[{"name":"V1","email":"info@3rd-Eden.com"}]},"0.0.7":{"name":"renderme","version":"0.0.7","description":"Render README files from github","main":"index.js","scripts":{"test":"mocha $(find test -name '*.test.js')"},"repository":{"type":"git","url":"https://github.com/3rd-Eden/renderme"},"keywords":["README","render","github"],"author":{"name":"Arnout Kazemier"},"license":"MIT","bugs":{"url":"https://github.com/3rd-Eden/renderme/issues"},"homepage":"https://github.com/3rd-Eden/renderme","dependencies":{"debug":"0.7.x","githulk":"0.0.x","marked":"0.3.x","pygmentize-bundled":"2.1.x","sanitizer":"0.1.x"},"devDependencies":{"chai":"1.9.x","mocha":"1.17.x","npm.js":"0.0.x","pre-commit":"0.0.x"},"_id":"renderme@0.0.7","dist":{"shasum":"efe4c4a3fd76930d74cbc71f54b64ac58dcd32a0","tarball":"https://registry.npmjs.org/renderme/-/renderme-0.0.7.tgz","integrity":"sha512-itRgsbB31ujaj8+Dpc1GVeTz1Cs0hlwp8uA4+jQp5Yyo4oR99lwvWU/1W596UaZKvtXYjj1O+lWprtrc9LTOow==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQC0Hsra1q1llAp8kd3vNmdb7GogVI7XJ6eWOYIOkbgW6QIhANPDHCCbrP9UqrQ+ZKoOQ1es+ZsYtiD2SL+oiCZ6NxD1"}]},"_from":".","_npmVersion":"1.3.21","_npmUser":{"name":"V1","email":"info@3rd-Eden.com"},"maintainers":[{"name":"V1","email":"info@3rd-Eden.com"}]},"0.0.9":{"name":"renderme","version":"0.0.9","description":"Render README files from github","main":"index.js","scripts":{"test":"mocha $(find test -name '*.test.js')"},"repository":{"type":"git","url":"https://github.com/3rd-Eden/renderme"},"keywords":["README","render","github"],"author":{"name":"Arnout Kazemier"},"license":"MIT","bugs":{"url":"https://github.com/3rd-Eden/renderme/issues"},"homepage":"https://github.com/3rd-Eden/renderme","dependencies":{"debug":"0.7.x","githulk":"0.0.x","marked":"0.3.x","pygmentize-bundled":"2.1.x","sanitizer":"0.1.x"},"devDependencies":{"chai":"1.9.x","mocha":"1.17.x","npm.js":"0.0.x","pre-commit":"0.0.x"},"_id":"renderme@0.0.9","dist":{"shasum":"3fea7702c255a1d36abdf67d0c227cd7c2f63019","tarball":"https://registry.npmjs.org/renderme/-/renderme-0.0.9.tgz","integrity":"sha512-ca0OyP8oN8b3Y5Qze0S/EFHxKLrf8A5Ycc37S6HrZrzmYVIlTZWQOtuYNCYd4EymXszZD+az00qqPu+w6m+1Sg==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIF0FcLzJGms5dZkn55P4xbTANyzxFkmmm1XyaiMZwrzAAiEA6MSBTWxnRpcOo/PY/aGD+9nkUZleLIiDxt1FeQPdCD8="}]},"_from":".","_npmVersion":"1.3.21","_npmUser":{"name":"V1","email":"info@3rd-Eden.com"},"maintainers":[{"name":"V1","email":"info@3rd-Eden.com"}]},"0.0.10":{"name":"renderme","version":"0.0.10","description":"Render README files from github","main":"index.js","scripts":{"test":"mocha $(find test -name '*.test.js')"},"repository":{"type":"git","url":"https://github.com/3rd-Eden/renderme"},"keywords":["README","render","github"],"author":{"name":"Arnout Kazemier"},"license":"MIT","bugs":{"url":"https://github.com/3rd-Eden/renderme/issues"},"homepage":"https://github.com/3rd-Eden/renderme","dependencies":{"debug":"0.8.x","githulk":"0.0.x","marked":"0.3.x","pygmentize-bundled":"2.1.x","sanitizer":"0.1.x"},"devDependencies":{"chai":"1.9.x","mocha":"1.18.x","npm-registry":"0.1.x","pre-commit":"0.0.x"},"_id":"renderme@0.0.10","dist":{"shasum":"9a3a447f3bbdb93481876698dc47faf4a151daa0","tarball":"https://registry.npmjs.org/renderme/-/renderme-0.0.10.tgz","integrity":"sha512-2jkhvIf5774o3u9ocFutlPVc4wCskD4jqD5Qc5E6nrs6bL48aLmkNk1antKs1SkDGWq0UQLiHG5KxKHN7oo0fA==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDA4d68Qro121D4N7fac+oNMqcxR23I+Nfa7aLQo0W8GgIhAMOnEqjaxAQPJOjiLl5tUGrRHeopPCHdQ40lTLKDN+qR"}]},"_from":".","_npmVersion":"1.3.21","_npmUser":{"name":"V1","email":"info@3rd-Eden.com"},"maintainers":[{"name":"V1","email":"info@3rd-Eden.com"},{"name":"swaagie","email":"info@martijnswaagman.nl"},{"name":"indexzero","email":"charlie.robbins@gmail.com"},{"name":"jcrugzz","email":"jcrugzz@gmail.com"}]},"0.0.11":{"name":"renderme","version":"0.0.11","description":"Render README files from github","main":"index.js","scripts":{"test":"mocha $(find test -name '*.test.js')"},"repository":{"type":"git","url":"https://github.com/3rd-Eden/renderme"},"keywords":["README","render","github"],"author":{"name":"Arnout Kazemier"},"license":"MIT","bugs":{"url":"https://github.com/3rd-Eden/renderme/issues"},"homepage":"https://github.com/3rd-Eden/renderme","dependencies":{"debug":"0.8.x","githulk":"0.0.x","marked":"0.3.x","pygmentize-bundled":"2.1.x","sanitizer":"0.1.x"},"devDependencies":{"chai":"1.9.x","mocha":"1.18.x","npm-registry":"0.1.x","pre-commit":"0.0.x"},"_id":"renderme@0.0.11","dist":{"shasum":"87fa11e673b5de90f132067d5d61c81cf8b70c9e","tarball":"https://registry.npmjs.org/renderme/-/renderme-0.0.11.tgz","integrity":"sha512-yZtW8D7u5LCf55etWvWbs6RJ8H9qrNcgxOJxXPEzgdXCv/o3BJVslLrMJQYajl7jG9pogsrs8Hav/l2c2AD0Tg==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCnKvPYuYsKsG255PlFjyy8nDxqATYsf0tYObhX3PmezAIhAJZw8VmJdsewIgeUPEjZZpWBi4X16qOO/U7uJamXW+nC"}]},"_from":".","_npmVersion":"1.4.3","_npmUser":{"name":"V1","email":"info@3rd-Eden.com"},"maintainers":[{"name":"V1","email":"info@3rd-Eden.com"},{"name":"swaagie","email":"info@martijnswaagman.nl"},{"name":"indexzero","email":"charlie.robbins@gmail.com"},{"name":"jcrugzz","email":"jcrugzz@gmail.com"}]},"0.1.0":{"name":"renderme","version":"0.1.0","description":"Render README files from github","main":"index.js","scripts":{"test":"mocha $(find test -name '*.test.js')"},"repository":{"type":"git","url":"https://github.com/3rd-Eden/renderme"},"keywords":["README","render","github"],"author":{"name":"Arnout Kazemier"},"license":"MIT","bugs":{"url":"https://github.com/3rd-Eden/renderme/issues"},"homepage":"https://github.com/3rd-Eden/renderme","dependencies":{"debug":"0.8.x","githulk":"0.0.x","marked":"0.3.x","pygmentize-bundled":"2.1.x","sanitizer":"0.1.x"},"devDependencies":{"chai":"1.9.x","mocha":"1.18.x","npm-registry":"0.1.x","pre-commit":"0.0.x"},"_id":"renderme@0.1.0","dist":{"shasum":"3a2ec233970e30ae466d6d85675e065222a2cc82","tarball":"https://registry.npmjs.org/renderme/-/renderme-0.1.0.tgz","integrity":"sha512-wFgxtndM1gx0PqltNU1+oGZGxY6QS/cruLIwIjiguXsql5pM2yrtSRQOLdTowryIkDOe5oPle8IoEh948HlETQ==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDID7Yzd3qdDAJSInZFFBNz0zo4c+z0dZhHdX9UuudV3AIhAIDOgEUWreKEt81q6OsDSQcAJ9SUtEDwwcmHzhKBfsWV"}]},"_from":".","_npmVersion":"1.4.3","_npmUser":{"name":"V1","email":"info@3rd-Eden.com"},"maintainers":[{"name":"V1","email":"info@3rd-Eden.com"},{"name":"swaagie","email":"info@martijnswaagman.nl"},{"name":"indexzero","email":"charlie.robbins@gmail.com"},{"name":"jcrugzz","email":"jcrugzz@gmail.com"}]}},"readme":"# Renderme\n\n[![Build Status](https://travis-ci.org/3rd-Eden/renderme.svg?branch=master)](https://travis-ci.org/3rd-Eden/renderme)\n\nRenderme is simple module with one clear goal: *Render README files*. It tries\nto render the files locally using the `marked` module in the same way as Github\nwould have rendered the files. Some details:\n\n- Sanitizes the outputted HTML using Google's caja parser.\n- Highlights code snippets using `pygments`\n- Falls back to the Github API for rendering when repository information has\n  been provided and we're unable to detect the content as Markdown.\n\nBut there are some small but intentional differences when we are rendering the\nREADME files locally. We add line number information to all the code snippets so\nit's more readable and people can actually jump to snippets which are on the\nREADME files. These code snippets are prefixed with a different CSS class then\nthe snippets that Github uses, we use `renderme` as a prefix for the code so you\nchoose how you want to style them your self.\n\n## Installation\n\nThis module is released in the npm registry.\n\n```\nnpm install --save renderme\n```\n\n## Usage\n\nThis module exposes a single function as primary interface. So you can simply\nrequire the `renderme` module and that would be all you need.\n\n```js\n'use strict';\n\nvar renderme = require('renderme');\n```\n\nThe `renderme` variable now contains a function. This function accepts the\nfollowing arguments.\n\n- `data` An object contains:\n  - `readme`: The actual contents of a README file\n  - `readmeFilename`: An optional filename of the README which is used for\n    markdown detection.\n- `options` An *optional* object which allows you to configure:\n  - `github` A pre-parsed object which contains a `user` and `repo` property\n    with the relevant Github repository information\n  - `githulk` A pre-configured [githulk] instance which will be used all\n    fallback when the given README file isn't a valid markdown file.\n  - `trimmed` The amount of chars we should assume that the supplied README data\n    is trimmed and we need to fallback to GitHub for rendering instead.\n- `fn` The completion callback, which follows the error first callback pattern.\n\nAs you might have noticed the `data` structure follows the same internal\nstructure as the packages in The npm Registry. Which makes it really easy to\nrender README files of modules which is also it's primary use case.\n\nGiven all this knowledge, rendering a README would be as simple as:\n\n```js\nrenderme({\n  readme: require('fs').readFileSync(__dirname +'/README.md', 'utf-8'),\n  readmeFilename: 'README.md'\n}, function rendered(err, html) {\n  console.log(err, html);\n});\n```\n\n## Debugging\n\nThis module make use of the `debug` module for logging debug information. To\ndisplay this information in your terminal you need to set the `DEBUG` env varible\nto `renderme*`:\n\n```\nDEBUG=renderme* node <entryfile.js>\n```\n\n## License\n\nMIT\n\n[githulk]: https://github.com/3rd-Eden/githulk\n","maintainers":[{"email":"charlie.robbins@gmail.com","name":"indexzero"},{"email":"jcrugzz@gmail.com","name":"jcrugzz"},{"email":"info@martijnswaagman.nl","name":"swaagie"},{"email":"npm@3rd-Eden.com","name":"v1"},{"email":"npm@3rd-Eden.com","name":"3rdeden"}],"time":{"modified":"2022-06-26T11:14:28.398Z","created":"2014-02-18T12:40:21.315Z","0.0.1":"2014-02-18T12:40:21.315Z","0.0.2":"2014-02-19T22:22:21.439Z","0.0.3":"2014-02-20T09:52:17.158Z","0.0.4":"2014-02-20T16:39:33.104Z","0.0.5":"2014-02-20T19:30:16.690Z","0.0.6":"2014-02-21T22:28:02.765Z","0.0.7":"2014-02-25T21:28:31.051Z","0.0.9":"2014-03-03T10:27:31.796Z","0.0.10":"2014-04-03T09:44:00.695Z","0.0.11":"2014-04-25T09:53:15.568Z","0.1.0":"2014-04-29T12:01:04.823Z"},"readmeFilename":"README.md","homepage":"https://github.com/3rd-Eden/renderme","keywords":["README","render","github"],"repository":{"type":"git","url":"https://github.com/3rd-Eden/renderme"},"author":{"name":"Arnout Kazemier"},"bugs":{"url":"https://github.com/3rd-Eden/renderme/issues"},"license":"MIT"}