{"_id":"@dschulmeis/ls-plugin-my-notes","_rev":"2-0a0bbbf9e07d03d1fa7627d365c914b5","name":"@dschulmeis/ls-plugin-my-notes","dist-tags":{"latest":"1.0.1"},"versions":{"1.0.0":{"name":"@dschulmeis/ls-plugin-my-notes","version":"1.0.0","description":"lecture-slides.js plugin for user notes","main":"index.js","repository":{"type":"git","url":"git+ssh://git@github.com/DennisSchulmeister/ls-plugin-my-notes.git"},"author":{"name":"Dennis Schulmeister-Zimolong","email":"dennis@patk.org"},"license":"BSD-2-Clause","dependencies":{"quill":"^1.3.7"},"scripts":{"do-publish":"npm publish --access=public"},"gitHead":"9d2cad8c89b42891f684733625dc19fb557ae701","bugs":{"url":"https://github.com/DennisSchulmeister/ls-plugin-my-notes/issues"},"homepage":"https://github.com/DennisSchulmeister/ls-plugin-my-notes#readme","_id":"@dschulmeis/ls-plugin-my-notes@1.0.0","_nodeVersion":"14.18.1","_npmVersion":"6.14.15","dist":{"integrity":"sha512-ft7k+44npAP8kHlWBl5rfl5gSyi/46t6Tfymfc9xYx0t6HdsT2N35eJFFAj0iRUL9QwvW8Xitp8yRZK1jiGPvA==","shasum":"91470f33ab4b990e59f70df883988c5adcff4797","tarball":"https://registry.npmjs.org/@dschulmeis/ls-plugin-my-notes/-/ls-plugin-my-notes-1.0.0.tgz","fileCount":5,"unpackedSize":9557,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJiF3pDACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2Vmoeuw//cSiQ6x+a6IihNy2Fed7aBRGcwuGJ2oSMyxcii/pdwiXIVoTX\r\nQOPZftTNhB17iUW8GOs6yqM1mQXGxlT3nwXGS7wT7FBYvjC9gyyBTH6rIVuG\r\nz2NJ6Th31EWCr86ogCsHoWF/MK+CF8o+uquLh4wYRpBSSa7NJtarJpnxEHEp\r\nJCRyQjGQPmEFhyGGm7PwQJ3+pyVXuAL3nuEGpPSYQ8Bt4zR+4yujaPf2aYse\r\nMXDnfy1ctlBmPS9hCCcEsWU2IOGArnTo9bn7T+QiM1bWIQzENy3q9rJPcOvw\r\n7ejMyMRqpc6W8xdeKMd/9FvOGcmexzRrM0nZyHDHZaYrdSlzfNRw/FUzwrzp\r\n/lZ7TMAmUv+Mpb6rUGd93ZT6kAMl5OvJ+y1RLM93NX1r/qy4KVbGYTAOmyfa\r\nHAkhK3Fx7byB/xRDP/olZa6W3vhbyxkpOMNCIi8+3K4+99A3BfD1aWpb9l9V\r\nk80gVaLNsSBHQExh6EBBQB8iAefrtL/qfxr8KOJAqwY4KdQO1rN+gJ0HfYn4\r\n/8/x38b/7GQjGeZfJZB/lrfZK9xgmIsHuRa7SgOx5lLpre2BhSSUnttpDZR2\r\nPu2icgCBykU5/Y8rCRd19N/aDq4CkFnn6urPvTTU0otOLp2i6hEJq8r+xXPf\r\nBJ+qZbnBSV/ZTKLr6tNdGGL8PBrXotnZi48=\r\n=6Wsm\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDtYwJ3xr2cgN3iNDgeuLAPeyLXgUK6oG/YXf/SWQTTSgIgcij7wt2oSkuLiir4rHrIZwf0WvEIKNn/znxZcfs53IA="}]},"_npmUser":{"name":"dschulmeis","email":"npmjs.com@windows3.de"},"directories":{},"maintainers":[{"name":"dschulmeis","email":"npmjs.com@windows3.de"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ls-plugin-my-notes_1.0.0_1645705794939_0.373811761983633"},"_hasShrinkwrap":false},"1.0.1":{"name":"@dschulmeis/ls-plugin-my-notes","version":"1.0.1","description":"lecture-slides.js plugin for user notes","main":"index.js","repository":{"type":"git","url":"git+ssh://git@github.com/DennisSchulmeister/ls-plugin-my-notes.git"},"author":{"name":"Dennis Schulmeister-Zimolong","email":"dennis@patk.org"},"license":"BSD-2-Clause","dependencies":{"quill":"^1.3.7"},"scripts":{"do-publish":"npm publish --access=public"},"gitHead":"cc287933fde41f3e32fa0ded9f8b30942d44f277","bugs":{"url":"https://github.com/DennisSchulmeister/ls-plugin-my-notes/issues"},"homepage":"https://github.com/DennisSchulmeister/ls-plugin-my-notes#readme","_id":"@dschulmeis/ls-plugin-my-notes@1.0.1","_nodeVersion":"14.18.1","_npmVersion":"6.14.15","dist":{"integrity":"sha512-BD9L8gQxqkguP5sPkcircAZ2DbC7v+xfuWCyEPs3125YTxmA3WwergTEnBctuPbPHiavfmpNLEcrMO18cTdLLA==","shasum":"ecb66441bf3ffc2dfb248fe9d478384ecdc788fd","tarball":"https://registry.npmjs.org/@dschulmeis/ls-plugin-my-notes/-/ls-plugin-my-notes-1.0.1.tgz","fileCount":5,"unpackedSize":9677,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJiIKyxACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmpMHRAAn1HzjTaxczbYrkwHsVZTA19v4Yg+N30ilkZmEp1hokpLcX+r\r\nIe9XfxW48NjKH/ClJLYhTQeck6Xv3+EAMkv/x7Ix4418p0YdHl157eMg0yIe\r\n+jvQGAKuq+YWmjU/nbyn/6YlbOrBPSMDwK+C4I/Kp3ibP6rdLgHYjD+oZAYL\r\nveHlbIaK9GA8WXYPwAfVMcxvMvzC30D7xG8LCi5FoYAjQB4vndwXMFXCN64G\r\nb5gndzbRDbAMMiRh0eVoF5YyiO8+uVHse8+vTjgNQh7IRlrlt0f083v96QR/\r\nXbnUTjU4r3YRjd+TbiJ8fVfrpEVNNe7s6eBoPY8SX+iH+EIMW4LxtC7qEuZK\r\nFagJviiNqheFJDan9GX2pAJWS1mYZ1s5wuNfG2DJmygfduKdSgOlRLkVcHR4\r\n9gdbeE3UIR0PxGkovCxmw/CUqHnTi/86WdgsaBmTt+560RL9q5L0CjTknBqB\r\napUL+MRTy1y1TM4gLrtV/hsN3Xp+SV9dJIKxt8YYZ3ctcMqoHMuDhr76uLqJ\r\nKxXjL+idbsxuiTSeubTpqlYMwe+J+cIQSBRiHO9OKUzwKR0eeGivD14Js5Nd\r\n2EOiNRX7zuZXN8lDjKbPTSxTbgkOYaeef5PCHD5/s1SLQaexuDyOWozt90If\r\nrZfYtIms0dZDZEHqOwvFGduEPu32VzspBno=\r\n=Qirq\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQC8+ZESczvPQl9digoexBznkLGJUvHk8BnkcZw3j+EVAAIgALXi+EVT679A0MNS6GzcYNaM2TzIz6wul008UeTNl/s="}]},"_npmUser":{"name":"dschulmeis","email":"npmjs.com@windows3.de"},"directories":{},"maintainers":[{"name":"dschulmeis","email":"npmjs.com@windows3.de"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ls-plugin-my-notes_1.0.1_1646308529624_0.5587334661317451"},"_hasShrinkwrap":false}},"time":{"created":"2022-02-24T12:29:54.898Z","1.0.0":"2022-02-24T12:29:55.137Z","modified":"2022-04-05T05:44:14.447Z","1.0.1":"2022-03-03T11:55:29.810Z"},"maintainers":[{"name":"dschulmeis","email":"npmjs.com@windows3.de"}],"description":"lecture-slides.js plugin for user notes","homepage":"https://github.com/DennisSchulmeister/ls-plugin-my-notes#readme","repository":{"type":"git","url":"git+ssh://git@github.com/DennisSchulmeister/ls-plugin-my-notes.git"},"author":{"name":"Dennis Schulmeister-Zimolong","email":"dennis@patk.org"},"bugs":{"url":"https://github.com/DennisSchulmeister/ls-plugin-my-notes/issues"},"license":"BSD-2-Clause","readme":"lecture-slides.js: Plugin for user notes\n========================================\n\nDescription\n-----------\n\nTODO: Update README\n\nThis plugin allows to use markdown syntax in to `@dschulmeis/lecture-slides.js`\nor `@dschulmeis/mini-tutorial.js` projects. Just add the `markdown` class to\na HTML block element or the `md` class to HTML inline elements to render their\ncontent with markdown like this:\n\n```html\n<section data-title=\"Example for markdown syntax\" class=\"markdown\">\n    # How to use markdown in a presentation\n\n    After enabling the plugin simply add the `markdown` class to any HTML\n    block element to render its content with markdown. Use the `md` class\n    for inline elements, instead.\n\n     1. Add the plugin to the project.\n     1. Instantiate the plugin in `index.js`.\n     1. Apply classes `markdown` or `md` in the HTML document.\n</section>\n```\n\nInternaly, `markdown-it` allong with `markdown-it-attrs` and `markdown-it-anchor`\nis used to render the markdown content to plain HTML. This allows to use curly\nbraces to set CSS clases directly in the markdown code like this:\n\n```markdown\n# Example heading with css class {.mt-0}\n\nParagraph with other CSS classes {.message .warning}\n```\n\nInstallation\n------------\n\n 1. Add the plugin to your project: `$ npm add --save-dev @dschulmeis/ls-plugin-markdown`\n 2. Create a plugin instance in `index.js` and pass it to the main object.\n 2. Use the `markdown` and `md` classes in the HTML content\n\nExample for `@dschulmeis/lecture-slides.js`:\n\n```javascript\nimport SlideshowPlayer from \"@dschulmeis/lecture-slides.js\";\nimport LS_Plugin_Markdown from \"@dschulmeis/ls-plugin-markdown\";\n\nwindow.addEventListener(\"load\", () => {\n    let player = new SlideshowPlayer({\n        plugins: {\n            Markdown: new LS_Plugin_Markdown(),\n        }\n    });\n\n    player.start();\n});\n```\n\nExample for `@dschulmeis/mini-tutorial.js`:\n\n```javascript\nimport MiniTutorial from \"@dschulmeis/mini-tutorial.js\";\nimport LS_Plugin_Markdown from \"@dschulmeis/ls-plugin-markdown\";\n\nwindow.addEventListener(\"load\", () => {\n    let mt = new MiniTutorial({\n        plugins: [\n            new LS_Plugin_Markdown(),\n        ]\n    });\n\n    mt.start();\n});\n```\n\nThe constructor of the plugin takes an optional configuration object with\nthe following properties:\n\n * `markdownIt`: Configuration values for the `markdown-it` library.\n Default: `{html: true, linkify: true, typographer: true}`\n\nCopyright\n---------\n\nlecture-slides.js: https://www.github.com/DennisSchulmeister/lecture-slides.js <br/>\nmini-tutorial.js: https://www.github.com/DennisSchulmeister/mini-tutorial.js <br/>\nls-plugin-markdown: https://github.com/DennisSchulmeister/ls-plugin-markdown <br/>\n© 2022 Dennis Schulmeister-Zimolong <dennis@pingu-mail.de> <br/>\nLicensed under the 2-Clause BSD License.\n","readmeFilename":"README.md"}