{"_id":"@atomdevelops/annotate","_rev":"3-02c4b1d29f95ff8cdea768a9fb71d590","name":"@atomdevelops/annotate","dist-tags":{"latest":"1.0.3"},"versions":{"1.0.0":{"name":"@atomdevelops/annotate","version":"1.0.0","description":"A simple markdown to HTML parser built with TypeScript","main":"index.js","scripts":{"build":"tsc && npm i -g"},"repository":{"type":"git","url":"git+https://github.com/atomisadev/noted.git"},"bin":{"annotate":"dist/index.js"},"keywords":[],"author":"","license":"ISC","bugs":{"url":"https://github.com/atomisadev/noted/issues"},"homepage":"https://github.com/atomisadev/noted#readme","dependencies":{"@types/express":"^4.17.15","@types/marked":"^4.0.8","@types/node":"^18.11.17","@types/yargs":"^17.0.17","express":"^4.18.2","fs":"^0.0.1-security","marked":"^4.2.4","yargs":"^17.6.2"},"gitHead":"2328ae611730b482bede05962918e573a1cf8f5e","_id":"@atomdevelops/annotate@1.0.0","_nodeVersion":"16.19.0","_npmVersion":"8.19.3","dist":{"integrity":"sha512-cH6gvfOSFYqBqN0cChl5UUJNcqCzhY4/RBGbKNPkYHtvedImhAoebd0lsMEC+qQq9hw0CXisVZizcWtXqTRMcA==","shasum":"d89de3357b8e9caff70c961373fb8165ee389b62","tarball":"https://registry.npmjs.org/@atomdevelops/annotate/-/annotate-1.0.0.tgz","fileCount":11,"unpackedSize":31414,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDtJpE4bW1TbV6sMOMX8NGiXp0JVdCf+m8dIyg8WU3aHwIhAL0zHNfyDlsbcEUNKSDchEso3cUxpFxmV7bIMrKU0D7f"}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjolY3ACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmrLfA/7BveI2a3k8WatjnxAv80uuqlmHluuC+tG/MpNRhnk3odnvALB\r\naXbsaiHBlm9Ws9SVwgMWJdsW9tByuPdpjFpkECXHL5rZRqDc729ayjVz7jHU\r\nIFDfhlMkAnJT/ClI0Qh5FJSe1r9K3G+V58UZX+lMmMXUmaE6nK0V7QNhgq+z\r\naU/emdT4w3nII2lGAE/2K81/u5xL4I46x6Aq6VFy2VN2jFW8cBl5+o2upQJb\r\nHWUTCv+yr3GiBlPfzk7hhqXg3f32Pdzloue1wgjpJmJgT4avhnqxGmakFO9c\r\n3tZhXGg+b/lBQSEQwinrp9K3yw4NkYUbRj0s7CfnfJgofrmRnuubbTbEkjKs\r\ncw5dEPqDKOMlrXC/qMITu9REI3gw1Xj8bK/I8DGqWtkqWVhb/dS3bWKx/WFL\r\n6CzWcTiIeLKMoIgIbIVajqpEmJW6asBNvK92E5WMx7XC+/8ZcnGx/xRPQGZs\r\nwe0ztu9KLwDX/XmUXZlwOXcSqhuKaFQwB/AuqVKgSNUvDgfelq2hJEwYixZP\r\n4eUDS07OTrUtVbi+VBAunRDsTtDHUM9eEtyR+CdNLggp5py+tAtEgJNQBM65\r\nbcqsvLcWZnV4o1BlGtxPSauT3unaGDJ/bqV9l7LAs80MR8KVUpQqbuNpxNVP\r\nb7DC/PnBHilJJPXoprzUq3p2e0gOLv2LyQ8=\r\n=r/wy\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"atomdevelops","email":"mohit.srinivasan3@gmail.com"},"directories":{},"maintainers":[{"name":"atomdevelops","email":"mohit.srinivasan3@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/annotate_1.0.0_1671583287576_0.5889533375237685"},"_hasShrinkwrap":false},"1.0.1":{"name":"@atomdevelops/annotate","version":"1.0.1","description":"A simple markdown to HTML parser built with TypeScript","main":"index.js","scripts":{"build":"tsc && npm i -g"},"repository":{"type":"git","url":"git+https://github.com/atomisadev/noted.git"},"bin":{"annotate":"dist/index.js"},"keywords":[],"author":"","license":"ISC","bugs":{"url":"https://github.com/atomisadev/noted/issues"},"homepage":"https://github.com/atomisadev/noted#readme","dependencies":{"@types/express":"^4.17.15","@types/marked":"^4.0.8","@types/node":"^18.11.17","@types/yargs":"^17.0.17","express":"^4.18.2","fs":"^0.0.1-security","marked":"^4.2.4","yargs":"^17.6.2"},"gitHead":"745ce5dab3a537471d703ea51719e25a95c66648","_id":"@atomdevelops/annotate@1.0.1","_nodeVersion":"16.19.0","_npmVersion":"8.19.3","dist":{"integrity":"sha512-gsvUjcdW+0r72L+iCDrsmE2kfvMxUb3q+aE+heniyYPeLHB5iqYoQXAS5rWQq+jm3uJjws+dAq/HFQi2CYuE5Q==","shasum":"276e3caa2847d99a222a3493db526da16db293a5","tarball":"https://registry.npmjs.org/@atomdevelops/annotate/-/annotate-1.0.1.tgz","fileCount":11,"unpackedSize":31422,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIDEKE83JSqox25DyhrcoObOreiJO/ChupuT4qfDqJBQvAiEAqaojAG8hwdUKbAYAqIL7pvzg5aII2RfR0lpdC9to/Ns="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjolZdACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2Vmp8Pg/9Hp24UtIVB96N/mzyARxa3UsWFjrBnsHp87/lD7+FOwcQRva+\r\nKxc2Fly1QSmNFxzMz/CGmlPI+k3hrIIsSlJSNGPKA/3i+4p+9xWDcVQWKA3w\r\n4I4/oVuuDRuawiFn/aYHiEWvkqGcA4D/kTdJwzjnv3xiTVcnO7oEAituSIju\r\nd7gFHF/VFALKb+pveeYsJ1aZWnFqnk6tyFvVl5UPVgQjTTrPx14V6Kjiumkb\r\nxEP3FUVL/VOB+HILwxXEtavjoPRypSXDcIl9gQDIQxs59+cBkn2VOagJpn7T\r\nElf1uMG3H2KDO96MtTi3zzhom4FDWoVGd/r7BFizO0Lzlete+kBY1IyYNO+O\r\nDYzLbANQJVP8jXwRpI9wcgEh1cp6SwN3qxTHAj5ziArC/LocALROmPAMER8J\r\nG6nPq5Nf5rmxxF9HgZpbQPwdIrHHiQDzFl0orH2AsyWhV9j6vANYOTgHEKEz\r\nF6n+T0oBF7DTC4yg1immhZv75e9N4A4H9qQKm9onb9mcHj3R7AOmeEP1wH8k\r\nQq1a8mXK4SQONLzN4LznI6nzN4AX3DxaKaO/mtFC+xl4/6ITcdzyldaMSAzR\r\ndELnG9IAPNADpn+eubu4KOQQ6N+v4vsRQTCuUlfgOLBa9khjyxLwBuAw+bEq\r\n8RezGwsJFpPt/IYDeKh61e21uAuqh5CcR48=\r\n=lcd2\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"atomdevelops","email":"mohit.srinivasan3@gmail.com"},"directories":{},"maintainers":[{"name":"atomdevelops","email":"mohit.srinivasan3@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/annotate_1.0.1_1671583325261_0.9393326551561558"},"_hasShrinkwrap":false},"1.0.2":{"name":"@atomdevelops/annotate","version":"1.0.2","description":"A simple markdown to HTML parser built with TypeScript","main":"index.js","scripts":{"build":"tsc && npm i -g"},"repository":{"type":"git","url":"git+https://github.com/atomisadev/noted.git"},"bin":{"annotate":"dist/index.js"},"keywords":[],"author":"","license":"ISC","bugs":{"url":"https://github.com/atomisadev/noted/issues"},"homepage":"https://github.com/atomisadev/noted#readme","dependencies":{"@types/express":"^4.17.15","@types/marked":"^4.0.8","@types/node":"^18.11.17","@types/yargs":"^17.0.17","express":"^4.18.2","fs":"^0.0.1-security","marked":"^4.2.4","yargs":"^17.6.2"},"gitHead":"76b851df41d1247a73c2296887e73630dbe2aeea","_id":"@atomdevelops/annotate@1.0.2","_nodeVersion":"16.19.0","_npmVersion":"8.19.3","dist":{"integrity":"sha512-qIHfBS/XFTVd45nOe5fJdvpHMw74otD1h+aLGh3Q09SNuroPHCDb6SmgEtKn9CQdLmQF3p9fZpokYoOLSTDfmA==","shasum":"1ca3d8ea3303dc1d9720762d75332f12d80baa71","tarball":"https://registry.npmjs.org/@atomdevelops/annotate/-/annotate-1.0.2.tgz","fileCount":11,"unpackedSize":32389,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIERFZuDSNvz/jHXYPqcnSVnnV9stejOpu6k+ita+aOR4AiBJhvzG7et7LdPW8df1W/z/AgHMy2wVMbcYQ70qCqFsBw=="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjolgXACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmrZxQ/9Hi0DYaW51KlEW9G/BLlV3pGQsf55JVP73ttjOasF8viQonTT\r\ndiNQt4iBEkO62ytuGo6g9P2HhJBO3aI3Wrys/Yb93aRLB68Xu1ahLay3Cm49\r\nE6iEzxIsBQWw8nbdV67KikSiZktQv+iuGZ4IAdzXA5z8u80U/v+cKx9UcjXg\r\nC88jX0t+2E4NT3i5NZwZL+W54s5vmmiaTfvOaEd9rnqlSa4iMgIHYiTAx5cu\r\nZ4OYpThXDvEUAFcfPnZjkHgtddVLbt5icLLtMt42Pnc3zr8yXIDaeZ67irQ8\r\nIQXCkSQqWIwHMGPhRw2xR1PT/oGZfj5zK2Nkqlx3Km43JcBZU07U1oviDh9T\r\nBtOxM2UTf8S/DXjz3s1dm28ojAs1vezMSUwCTgDQcqPCg2JbD1WLkP6FOwlM\r\nC4xMsVjDsv2hxbmNxfRdDNnQgrIxTp7unhQ+9f2k88piQZAncpH7JnoQJTr2\r\nf7XSzEFzzv5iGu0WvMxX+FLCThjSNhi509J7d0GCCj3zFxTWyfcCElu9D54H\r\nnsb6cKFa7WRQ6hO4NBhs/jfvOd9G3qQBGZHX6NYp/ygmv02iBaaKyex+HGE8\r\nqs1rfcfWdXgZRi2V+zP1yxJB88MZ8N3j9XDR76aJUkEREBPj70ePERDaBXtt\r\nj4WU44pvsUG4tBobspxhfFkCo7vAVc1ue64=\r\n=6efp\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"atomdevelops","email":"mohit.srinivasan3@gmail.com"},"directories":{},"maintainers":[{"name":"atomdevelops","email":"mohit.srinivasan3@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/annotate_1.0.2_1671583767253_0.3284182808448666"},"_hasShrinkwrap":false},"1.0.3":{"name":"@atomdevelops/annotate","version":"1.0.3","description":"A simple markdown to HTML parser built with TypeScript","main":"index.js","scripts":{"build":"tsc && npm i -g"},"repository":{"type":"git","url":"git+https://github.com/atomisadev/noted.git"},"bin":{"annotate":"dist/index.js"},"keywords":[],"author":"","license":"ISC","bugs":{"url":"https://github.com/atomisadev/noted/issues"},"homepage":"https://github.com/atomisadev/noted#readme","dependencies":{"@types/express":"^4.17.15","@types/marked":"^4.0.8","@types/node":"^18.11.17","@types/yargs":"^17.0.17","express":"^4.18.2","fs":"^0.0.1-security","marked":"^4.2.4","yargs":"^17.6.2"},"gitHead":"0455aedeaab3794051a4ea6075785b926882eabf","_id":"@atomdevelops/annotate@1.0.3","_nodeVersion":"16.19.0","_npmVersion":"8.19.3","dist":{"integrity":"sha512-IwnOjiW1DFpunKFTIxL5/5nENkckiPj1NDGsyaYSWYkK41l+cSDzkU2swd1RMwQfPV/Ch8U+6oJV5jxyZKIw1A==","shasum":"222376a923ca1d7ffb360adef062d03b04d8e806","tarball":"https://registry.npmjs.org/@atomdevelops/annotate/-/annotate-1.0.3.tgz","fileCount":11,"unpackedSize":32389,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIEAW8LzBH1dF9Zb1WjCyZ/FlwquJ6J67t88yM2+1hPKqAiEAlHaIAxL2Ipr76izXP+dN3KhEIfyRFNTXec3FpyGWqjc="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjolixACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmqeChAAjEgjW50lejIZtObu0+UCzvcCPhKIyyzYKXOX5zzABEZ//h8l\r\nuGu88YMDuXbcrz6yHlki1sTs0WO+oRTd5LoP60oG/46aOwDrUMVdKsKBdK/5\r\nxvUDJ4MzGZGd9dIig2n1chtr54t2gaw1w5k90N+2pw2grgJWYzGHDVoX/Rkr\r\nmnJ8NXBTO+xOMMgTCAtJuksTSJQPBsAf2NfWyRnT33wDrwS8/O8itIUH75Q5\r\nrH/MsEccnyVx0drZSecdyIdpnzvepE28eAUtNMuC3jsXgY74L8VolMRMlP3v\r\nmwgJKkTpNmxgedCEhDUbthzeXyvxIdqbzc4LAMMGGVafJwV3mdPf2YMct+g6\r\n6Ex/9qUxuy0l8sHhHKVYVlDP6Itr28unkouKUK6Qx5H/lzzVHrAsPEGhwVzJ\r\nts7EbUad7jkRvw2T3WF3isGsNkRFfOaRAjvQE8MQbo/r7BzFbqHNcPw85EE0\r\n5YzDeaZnRNiAxhuWL5ZfZWMxfBOWIuFIleOVpJyPruusqtycgeCtSiNFbUlu\r\nIw83mLYTioWJrV8PaZpw9Gt38XI20CvR1GaxYzK+zuD3pqiyTaYsEuDqtUki\r\n+xiOiELbxbmJ5OTD/pz04GZksyktuuYTxhIIlYwvAvhwG4TArHBIMFaKYmcM\r\nS6/jDqKp81k1/qGl0IenNVv+eInuvdrKDZs=\r\n=120M\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"atomdevelops","email":"mohit.srinivasan3@gmail.com"},"directories":{},"maintainers":[{"name":"atomdevelops","email":"mohit.srinivasan3@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/annotate_1.0.3_1671583921539_0.11869528315391098"},"_hasShrinkwrap":false}},"time":{"created":"2022-12-21T00:41:27.517Z","1.0.0":"2022-12-21T00:41:27.715Z","modified":"2022-12-21T00:52:01.828Z","1.0.1":"2022-12-21T00:42:05.471Z","1.0.2":"2022-12-21T00:49:27.443Z","1.0.3":"2022-12-21T00:52:01.740Z"},"maintainers":[{"name":"atomdevelops","email":"mohit.srinivasan3@gmail.com"}],"description":"A simple markdown to HTML parser built with TypeScript","homepage":"https://github.com/atomisadev/noted#readme","keywords":[],"repository":{"type":"git","url":"git+https://github.com/atomisadev/noted.git"},"bugs":{"url":"https://github.com/atomisadev/noted/issues"},"license":"ISC","readme":"# 📓 Annotate\n\nEasily compile your notes in markdown into static web pages. You can then deploy these static pages to your host of choice such as GitHub Pages, Vercel, Netlify, etc.\n\n## Features\n\n- Automatic LaTex support (`$` for inline, `$$$` for multi-line)\n- Table of Contents\n- Instant compilation\n- Easy deployment\n- Development mode (serve your HTML websites automatically using `annotate serve`)\n  - HMR (hot module replacement) coming soon\n\n## Installation\n\nInstallation of this is quite simple. You can clone the source code and run it. Or, if you prefer a CLI tool, you can install `annotate` from npm.\n\n```bash\nnpm install -g @atomdevelops/annotate\n```\n\nOnce you've installed `annotate`, you can use it in your terminal.\n\n```\nannotate --help\n```\n\n## Usage\n\nThe `annotate` CLI currently only offers two stable commands. Suggestions are highly recommended, you may leave them in the [Issues](https://github.com/atomisadev/annotate/issues) tab.\n\n### annotate compile\n#### Description\nMain command to compile your markdown files into statically generated, deployable HTML documents.\n\n#### Parameters\n- `inputDir` - Input directory containing the markdown files to be compiled\n- `outputDir` - Output directory where the HTML files should be compiled to\n\n#### Example\n```bash\nannotate compile inputDirectory/ outputDirectory/\n```\n\n### annotate serve -d (directory) -p (port)\n#### Description\nAutomatically serve your statically generated HTML using Express to a provided port (defaulted to `8080`).\n\n#### Parameters\n- `--directory`, `-d` - Directory to serve the HTML files\n- `--port`, `-p` - Port to listen to (if not provided, defaulted to `8080`)\n\n#### Example\n```bash\nannotate serve -d outputDirectory/ -p 3000\n```\n\n## Preview\n\nA preview is currently unavailable.\n","readmeFilename":"README.md"}