{"_id":"@aaron-cw/markdown-generator","_rev":"4-3cbf2e15eeab289d1b96b4c4dcf4dd6b","name":"@aaron-cw/markdown-generator","dist-tags":{"latest":"1.0.3"},"versions":{"1.0.0":{"name":"@aaron-cw/markdown-generator","version":"1.0.0","description":"Creates a static website from markdown files","main":"index.js","scripts":{"build:docs":"node ./automation/build-docs.js","copy:readme":"node ./automation/copy-readme.js","serve":"http-server .","test":"jest --coverage","clean":"node ./automation/clean.js","integrate":"npm run clean && npm run test && npm run build:docs && npm run copy:readme"},"repository":{"type":"git","url":"git+https://github.com/s33r/markdown-generator.git"},"keywords":["markdown","html","documentation","generator"],"author":{"name":"Aaron Willows","url":"aaron@aaronwillows.com"},"license":"MIT","bugs":{"url":"https://github.com/s33r/markdown-generator/issues"},"homepage":"https://github.com/s33r/markdown-generator#readme","dependencies":{"directory-tree":"^2.2.1","fs-extra":"^7.0.1","highlightjs":"^9.12.0","lodash":"^4.17.11","log4js":"^4.0.2","lunr":"^2.3.5","marked":"^0.6.0","yaml-front-matter":"^4.0.0"},"devDependencies":{"del":"^3.0.0","http-server":"^0.11.1","jest":"^24.1.0"},"gitHead":"3973615bae2884a46342781ac25d524acffb3b61","_id":"@aaron-cw/markdown-generator@1.0.0","_npmVersion":"5.5.1","_nodeVersion":"9.3.0","_npmUser":{"name":"aaron-cw","email":"aaron@aaronwillows.com"},"dist":{"integrity":"sha512-pePa9l0jDD5NeMWUKby5a8LlSDRImePCG/Gi0mgVxr01ZMLKyucQ97WO0tHOJP83vpb2mJv3ksEyZn+Mf5z0KA==","shasum":"df0aee670399382ae39f1cbd7fc6f8c132c63e05","tarball":"https://registry.npmjs.org/@aaron-cw/markdown-generator/-/markdown-generator-1.0.0.tgz","fileCount":49,"unpackedSize":84037,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJcZ2JsCRA9TVsSAnZWagAA7g8P/0eQbrjhkoDisj2am8wW\nh2ORE7gONjmTpK8FObHCcwqVVjTgGmwxFnPNkmkr5UCRMmuuNuzHMw7q9Cwy\nx5a21j3E5Awauzu6uNk687uzpAcJIz06mRWcI++p5nDuCi5DNBAmJdoJHwaG\nPVXP+2+uhXLn1r9PXKO/AMxF9TOYgohLiN4+IPOpFRsfRmMGd3XC6QkofDDB\nExL2iA3iIviX+PWHddUHYzT91ypvjhEhCAZmp3XNUfYoBbuKwJLuUoO46Bz1\nE8XUYztuNpIpgqwLcT553wmN2OpAJ0TbL6T86D7XHv2IgrtDOPTwgNnwUjAY\ngzTcsoPfNR5sZTwWGReQ0J3ovVBvvpJH5D10NKa7T5tbyheKeBAY+ohnrfHu\nnh9bLvJLG8sHgQmQoaWXz4lB6YbFEcK2bSAO1HkUpuiptFexCbcnxk4BeEDB\nHKYxveOBy3qnENCUlkpXxaSKAqFmPvn3hZELagMJF0pbFw1pGutqp7PWav6l\nPX9oTlCrLuZMupYta7MOY6qYnKSpZJyZ3XyGtfd/BNL16XBx/+PUVXuvX0jD\nq4Hj/C1LPUUWKFqFYkOwUyrLKMHAI/6YjTL7PjqPW1UaIb+A92RN7hzCprNf\ndIuVsfC1XxHBlprH7cMUT2KA3y8QAWkNlY1T53VEUptLCc9J0LFzAxqyGYnw\nYxS8\r\n=zpPJ\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDh6TB/ZJs887UZZEQPe6CEsWH+4LzLgTAbK2bvDXasAAIhAPYEJGaiG0GBG7THFpkLouHBrsexh+GgMCmbJJtuqVNM"}]},"maintainers":[{"name":"aaron-cw","email":"aaron@aaronwillows.com"}],"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/markdown-generator_1.0.0_1550279275583_0.1625110218539707"},"_hasShrinkwrap":false},"1.0.1":{"name":"@aaron-cw/markdown-generator","version":"1.0.1","description":"Creates a static website from markdown files","main":"index.js","scripts":{"build:docs":"node ./automation/build-docs.js","copy:readme":"node ./automation/copy-readme.js","serve":"http-server .","test":"jest --coverage","clean":"node ./automation/clean.js","integrate":"npm run clean && npm run test && npm run build:docs && npm run copy:readme"},"repository":{"type":"git","url":"git+https://github.com/s33r/markdown-generator.git"},"keywords":["markdown","html","documentation","generator"],"author":{"name":"Aaron Willows","url":"aaron@aaronwillows.com"},"license":"MIT","bugs":{"url":"https://github.com/s33r/markdown-generator/issues"},"homepage":"https://github.com/s33r/markdown-generator#readme","dependencies":{"directory-tree":"^2.2.1","fs-extra":"^7.0.1","highlightjs":"^9.12.0","lodash":"^4.17.11","log4js":"^4.0.2","lunr":"^2.3.5","marked":"^0.6.0","yaml-front-matter":"^4.0.0"},"devDependencies":{"del":"^3.0.0","http-server":"^0.11.1","jest":"^24.1.0"},"gitHead":"20d2192337e80dcf172c1e0e60f0be9cc8773bd1","_id":"@aaron-cw/markdown-generator@1.0.1","_npmVersion":"5.5.1","_nodeVersion":"9.3.0","_npmUser":{"name":"aaron-cw","email":"aaron@aaronwillows.com"},"dist":{"integrity":"sha512-7WFBD6iYdDaeIxrRdf161ZYscgsLdWzM8079KvT077RZHA/xzRHgaALEMRBtGh0RVqvGeInxKMUMid3wllg56Q==","shasum":"9afd981354b1cc2857d9d6169956c0148a792f6d","tarball":"https://registry.npmjs.org/@aaron-cw/markdown-generator/-/markdown-generator-1.0.1.tgz","fileCount":49,"unpackedSize":85164,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJcZ2SyCRA9TVsSAnZWagAAV6cP/1RQWtecUb4BAtBNHA7A\n+7cUNZDFsec7CBaRFML3S9YwQmCwhIWB11zhRrADmQ2PtfVydFubiVQvQMPH\nmd6it6R5vltxFETdXqo6ymeePoWE/CvGynBaqzwTMIcwaJquK+BFhxvT0OnA\nE4siIhYOtjlyKhD2ZMj5ioeYxj+yaRApecgIjCWEAM1v83Ei5GpDqSBdX7oP\naQlAsU5LoKjP7CBvZrwHmaFMX4ohMTd5SJELrg1R9ZupEFsmNQUwJbbXhnmu\nAyaJbVT6y3Bob0X7HAC7/TGE21KN+e/McQZFSoRqPz7dKNDeht2uxWWFBNhH\nOTOIWMSSAWGuaSpMEWAP0MmvuRnVM7LtqjURX/RUFeK60vSFhQZb2uXl1wzm\nsCCRE6RK8aV+QyyjBU5DicR035lGMnK3zGXEUXAdNxZcZJv9Ihcb4NyK4EkT\ncYB8f6voDNL+lYLPva7KXyWCOTJ7vpMaAjcUM0wfiF5OBjSRWLibsrxWV/sf\nItLEMxNG1PPlI6e2EscAdx4ec4ZzQj2n+ZP2uJBT9oq9E4VZzQS1dnwxqbb1\nli0/FmeXWVBhznNx1KLNzpkUGgfObN8XZ6MJvjyC5yPYWcx9hC8TRjToB7v8\nkCoHWWZKi9Uh3et+zhakgAWDjtwJyy3LZeUACaP9m/buqT18LmTBijv2EHYy\nIKvb\r\n=lGGd\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDkMVRjU10uicKKfeoWIKTLkUTDNdusH1dsWPK2d/yJUgIgVq5cOowQx2vlaz8wOP0MuslP9fqE3IT2hFD7KqsEcpk="}]},"maintainers":[{"name":"aaron-cw","email":"aaron@aaronwillows.com"}],"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/markdown-generator_1.0.1_1550279857934_0.30495718548419193"},"_hasShrinkwrap":false},"1.0.2":{"name":"@aaron-cw/markdown-generator","version":"1.0.2","description":"Creates a static website from markdown files","main":"source/index.js","scripts":{"build:docs":"node ./automation/build-docs.js","copy:readme":"node ./automation/copy-readme.js","serve":"http-server .","test":"jest --coverage","clean":"node ./automation/clean.js","integrate":"npm run clean && npm run test && npm run build:docs && npm run copy:readme"},"repository":{"type":"git","url":"git+https://github.com/s33r/markdown-generator.git"},"keywords":["markdown","html","documentation","generator"],"author":{"name":"Aaron Willows","url":"aaron@aaronwillows.com"},"license":"MIT","bugs":{"url":"https://github.com/s33r/markdown-generator/issues"},"homepage":"https://github.com/s33r/markdown-generator#readme","dependencies":{"directory-tree":"^2.2.1","fs-extra":"^7.0.1","highlightjs":"^9.12.0","lodash":"^4.17.11","log4js":"^4.0.2","lunr":"^2.3.5","marked":"^0.6.0","yaml-front-matter":"^4.0.0"},"devDependencies":{"del":"^3.0.0","http-server":"^0.11.1","i":"^0.3.6","jest":"^24.1.0","normalize.css":"^8.0.1","npm":"^6.8.0"},"gitHead":"7b8b33b403cd11e3e8443145e766668556d07433","_id":"@aaron-cw/markdown-generator@1.0.2","_npmVersion":"5.5.1","_nodeVersion":"9.3.0","_npmUser":{"name":"aaron-cw","email":"aaron@aaronwillows.com"},"dist":{"integrity":"sha512-l6/9n81l2BE95g5jDKpYqZ4wFp3iYuMdsQNNYSd7VkkB4NObDjpKvgnP1IyEP5w9TdYdsL5Q6H0goEt+QTs6ig==","shasum":"7e4a3129219c5efba559f6d9e888b770c8050031","tarball":"https://registry.npmjs.org/@aaron-cw/markdown-generator/-/markdown-generator-1.0.2.tgz","fileCount":53,"unpackedSize":100416,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJcaNFRCRA9TVsSAnZWagAANlEP/003rjQnWgoJ/CqfoM1e\n1HYekRUeDdKk3u3IjaDsWfJf3bRjaxdpue8hgoFifTXbq9eW2xdBR6AhZ+5v\nXncfIvFv453qmWWJh1mkmQ5G2HXFxZGmySERIlGglcPcK11IyCFXYp4PCUtk\nNfjlScCVhqB3/+sjb+k1P2jOxqpbYpYxgxRml/9mqmHxKxoKv30/g4diQtPD\n86acZQWrmHZxu2p5+PkPC+032YZtdZqx9RaTESxxFk20N/SFH0K/SIx3z8f+\nMnlfCZMzsYai9CXYpt2UzQJQDPeJlRgflCa157MqzCV0Th+E6GW5yAPps6Rz\n8wz1SeUGjsL3oPGQOp7dvoFdQ8/ChBE6lRedGYqf9gezxVuWXMZTsxnfWcoG\nwbqPAg2Xr4hh+RX9RPRamooi5SZ+4VGTti5n2aMWxWa+sJwDiadNHYJq1OYE\n1kRv71B4pgHfJGzbIDqbdNDiMDH5xLp8v5QYrT3V1Nv9toI0LPnSlB4rwRn4\nGsMr5BUqNtkyU0OLs4awzlG1A/8CsEjmJrK4YrTcsMxe7uGZ8yRQMM8AszLL\nxWpRJUaOZsvi0cDQd4F2wPk1BdqdW/PgwNqeXtDVMRNaGRW5NlsLYSHqdMiE\n0hfxWDKRyctrs4GPeOMpGiEprj5ErkutyQoNtosDnah+Ok4nlPPGOEvOoZ4c\nj3fR\r\n=hjj7\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDypZ29xV0WTZEh4D+99FUI6d4VxafdVdWLgJLBC43y3AIgFhbHVaKtPa4bBv29AdLOoYLV7PiyehuKqa/SEAFyArM="}]},"maintainers":[{"name":"aaron-cw","email":"aaron@aaronwillows.com"}],"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/markdown-generator_1.0.2_1550373200594_0.8024990651582002"},"_hasShrinkwrap":false},"1.0.3":{"name":"@aaron-cw/markdown-generator","version":"1.0.3","description":"Creates a static website from markdown files","main":"source/index.js","scripts":{"build:docs":"node ./automation/build-docs.js","copy:readme":"node ./automation/copy-readme.js","serve":"http-server .","test":"jest --coverage","clean":"node ./automation/clean.js","integrate":"npm run clean && npm run test && npm run build:docs && npm run copy:readme"},"repository":{"type":"git","url":"git+https://github.com/s33r/markdown-generator.git"},"keywords":["markdown","html","documentation","generator"],"author":{"name":"Aaron Willows","url":"aaron@aaronwillows.com"},"license":"MIT","bugs":{"url":"https://github.com/s33r/markdown-generator/issues"},"homepage":"https://github.com/s33r/markdown-generator#readme","dependencies":{"directory-tree":"^2.2.1","fs-extra":"^7.0.1","highlightjs":"^9.12.0","lodash":"^4.17.11","log4js":"^4.0.2","lunr":"^2.3.5","marked":"^0.6.0","yaml-front-matter":"^4.0.0"},"devDependencies":{"del":"^3.0.0","http-server":"^0.11.1","i":"^0.3.6","jest":"^24.1.0","normalize.css":"^8.0.1","npm":"^6.8.0"},"gitHead":"92c85ceef5461d9c3422c227e6aa7a9f0af44fcd","_id":"@aaron-cw/markdown-generator@1.0.3","_npmVersion":"5.5.1","_nodeVersion":"9.3.0","_npmUser":{"name":"aaron-cw","email":"aaron@aaronwillows.com"},"dist":{"integrity":"sha512-+VPcYS/qLFB8ahQwEfa4bgynvf/TVM1wIdhrj1QmNszsdxLZ4rJVPWwrKX/kZx584bdTLKbPsnWJZvgaK3Q9DQ==","shasum":"5211eea9530a504fcf070229842dc9060aea3115","tarball":"https://registry.npmjs.org/@aaron-cw/markdown-generator/-/markdown-generator-1.0.3.tgz","fileCount":55,"unpackedSize":121137,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJcaO+MCRA9TVsSAnZWagAA6JAP/A+bPD1vJFSXvB1RNbwW\nNkeNnM+1MKYycZSA/CBwVAXWHVZ5f0a79BRuOYvRCqDTEQxNPqMS3L5KfJiz\ny7OvCs8YJVJLob5iXGCFvN79HkImWT01xlz947BSZ76JWQ6mkABQURRa1NEo\n7obN1wJbZ7UFDun2ZAtBOI5LqUq2BnapBsZ8/96jlBLx10JQKdeKQ71BhSyQ\nIOhkRBDWZQ8U2XSfS2q4x8sxYrTVv6M2GJBrtsi6w6kw+k4XGPFU7ELSiozq\njr0QP5bIE6aN2fyXPYONwAjJ+5ZX7qKvWgk9HHruoEl8sV0rnbw9Np1UHf6p\nAxguQQv3zYDEMYFUwK+mBw720+ETDrLyRavxfSIQp/czfKIITHcQ5VoeXoGi\nfU/D99NXOOXf+lXplZhZuHtKoN9W/u/1CtHSUZbGwtUMz1VxpgLYimtzyGqf\n948KiIKlH9gekEE+i46VkSfiIBungN8qjjjqmrXos1YmX1KdDgu4z0ymxI9m\nDxwj6EmYJUvKrmUQKmcLaZ1raMXlIsiBHAC76J6fUBZEuf/msbAmwHxN/4Tg\neF/NDxfWtBOqEwpzvgJLYNXEQLLRCLFVx9/50WSyKjyb8gayKSlekb6jDlUN\ngYRFuICimpmFkI1XHOm9wK8OFd0gzL1lQBncCknVw/pNvszHCHQmAyKQT0wY\n9veG\r\n=w5s5\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIF8+6kmclQkrmHXphjG4LAiTsz90C1ypQ/qPwNZPkbmZAiBmLpzp/yPJdOlRr0XBWM95UAW1g6dexBgFlTB+U6QaXg=="}]},"maintainers":[{"name":"aaron-cw","email":"aaron@aaronwillows.com"}],"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/markdown-generator_1.0.3_1550380939953_0.932981226540869"},"_hasShrinkwrap":false}},"time":{"created":"2019-02-16T01:07:55.405Z","1.0.0":"2019-02-16T01:07:55.803Z","modified":"2022-04-04T10:55:32.117Z","1.0.1":"2019-02-16T01:17:38.098Z","1.0.2":"2019-02-17T03:13:20.776Z","1.0.3":"2019-02-17T05:22:20.133Z"},"maintainers":[{"name":"aaron-cw","email":"aaron@aaronwillows.com"}],"description":"Creates a static website from markdown files","homepage":"https://github.com/s33r/markdown-generator#readme","keywords":["markdown","html","documentation","generator"],"repository":{"type":"git","url":"git+https://github.com/s33r/markdown-generator.git"},"author":{"name":"Aaron Willows","url":"aaron@aaronwillows.com"},"bugs":{"url":"https://github.com/s33r/markdown-generator/issues"},"license":"MIT","readme":"# Markdown Generator\n\n[![Build Status](https://travis-ci.org/s33r/markdown-generator.svg?branch=master)](https://travis-ci.org/s33r/markdown-generator)\n\nCreates a static site from markdown files.\n\nThis software is still in development and not production ready.\n\n[Github Repository](https://github.com/s33r/markdown-generator)\n\n## Installation\n\n```shell\nnpm install markdown-generator --save-dev\n```\n\n\n\n## API Usage\n\n```javascript\nconst markdownGenerator = require('markdown-generator');\n\nmarkdownGenerator();\n\n```\n\n## Configuration Options\n\nUsage:\n```javascript\nconst markdownGenerator = require('markdown-generator');\n\nconst configuration = {\n    \n    // The directory where the generator will search for markdown files.\n    inputLocation: path.resolve(__dirname, '../documentation'),\n    \n    // The directory where html will be output.\n    outputLocation: path.resolve(__dirname, '../deploy/docs'),\n    \n    // The file to use as the template for rendering html\n    templateLocation: path.resolve(__dirname, './templates/index.html'),\n    \n    // If true, do not output any files.\n    dryrun: false,\n    \n    // If true, search will be enabled. If search is disabled, you may want to remove it from the default template.\n    enableSearch: true,\n    \n    // The title to use for the static site.\n    title: 'Default Documentation',    \n};\n\nmarkdownGenerator(configuration);\n\n```\n\n## Markdown Format\nmarkdown generator uses [GitHub Flavored Markdown](https://github.github.com/gfm/) and is parsed with [marked](https://github.com/markedjs/marked). \n\nA cheatsheet is available: [https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet]\n\nThere is one non-standard extension to markdown. Markdown Generator has the ability to inclde code files inline. \n\nTo do so:\n\n```markdown\n```javascript?./inline-example.js\n\n\\```\n```\n\nAnd it renders as:\n```javascript?./inline-example.js\n\n```","readmeFilename":"README.md"}