{"_id":"@dschulmeis/ls-plugin-markdown","_rev":"1-a0c8ed2961f3e9aa59727f318c9c2341","name":"@dschulmeis/ls-plugin-markdown","dist-tags":{"latest":"1.0.0"},"versions":{"1.0.0":{"name":"@dschulmeis/ls-plugin-markdown","version":"1.0.0","description":"lecture-slides.js plugin for markdown syntax","main":"index.js","repository":{"type":"git","url":"git+ssh://git@github.com/DennisSchulmeister/ls-plugin-markdown.git"},"author":{"name":"Dennis Schulmeister-Zimolong","email":"dennis@patk.org"},"license":"AGPL-3.0","dependencies":{"@dschulmeis/ls-utils":"^1.0.2","@sindresorhus/slugify":"^2.1.0","markdown-it":"^12.3.2","markdown-it-anchor":"^8.4.1","markdown-it-attrs":"^4.1.3"},"scripts":{"do-publish":"npm publish --access=public"},"gitHead":"1cf9a415357e69625f4bee52d4cc3b2e26f3333b","bugs":{"url":"https://github.com/DennisSchulmeister/ls-plugin-markdown/issues"},"homepage":"https://github.com/DennisSchulmeister/ls-plugin-markdown#readme","_id":"@dschulmeis/ls-plugin-markdown@1.0.0","_nodeVersion":"14.18.1","_npmVersion":"6.14.15","dist":{"integrity":"sha512-3bwFE4kqCjHffCA3FWOjGeakmyeniDXA9oTG4qDjY7l6NH4LVBWpNMIOlg+TzjRtHy6pUNwuphW3YWcefsJg4Q==","shasum":"5455bd8a9247374d769d6ea0e1047ed3fd09a75d","tarball":"https://registry.npmjs.org/@dschulmeis/ls-plugin-markdown/-/ls-plugin-markdown-1.0.0.tgz","fileCount":4,"unpackedSize":7233,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJiFCh/ACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2Vmo5GQ//fdx2QlrseFdDOeDcVOBL2yvmzXTWWRPn/K54KiwF8x14JX7E\r\nCtoGxbzGiR2Ub2fU8oJGyDf+TuumZY2JI5qnqEwyQYbt+TVI3vzBZUMgcoL2\r\nvSN0qSkPxxGaKhjsWdLX4djWp+CF3WifeG/dRc4CXRWrNiGDVDWP9gMud1pu\r\naaagi2SJS7uGwnP0D3hvRN+o7q/eXB+WZxj4seCK6wDUQMonI8NwArcxj6CG\r\nMwzDQoqZssaFVwHvAgbQlcBR2/KmtOCvQBgN+dnaEc8tIRw59b4onzbsJEAh\r\n6MSacbAFg/jnPPijng/WwLaz6ToKK1OeTDcPcbQdP8o+ben5MQmG76N7hFf/\r\nsIXRI5aM6b3w9rcIV9wIFLRL201wIQ2YzaWZ9T3jUpdNavbsczNM29HK2ZPY\r\nTtcSUu/Map44F/XT8/B0xackIi+QQi1uDnc/yJVxX/+prW6SV5yNc8GDPItk\r\nR3upzPZVcMZvkGsQ7xejLEmx1114kzpC0BhyVY7LdUxF+QUEjxFYtAJ+G/TD\r\ntRBip7RT4mhOEp9uOalS5nqho6FXujKRzr22Re0+SFM/VNg51MNXkE0J+BRY\r\nnn8XyspYx7hi6Np6kJW4owLV5il2PF/RNYyDxeheR46+NkzBNTse0pbKFsKy\r\nmWEsLw6fafHwU3DlIO1yKOOrx1AVRjgVNgI=\r\n=qDf8\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDpDPccgsESlfsNfixO5NBYsZFEwDF4GmQv9/cff3KXqQIgEVpFSeXRHaDjJCFDm9t/fZsHeLgBAEAMBTxtym3Ruow="}]},"_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-markdown_1.0.0_1645488255400_0.2471480465541036"},"_hasShrinkwrap":false}},"time":{"created":"2022-02-22T00:04:15.340Z","1.0.0":"2022-02-22T00:04:15.579Z","modified":"2022-04-05T05:44:14.257Z"},"maintainers":[{"name":"dschulmeis","email":"npmjs.com@windows3.de"}],"description":"lecture-slides.js plugin for markdown syntax","homepage":"https://github.com/DennisSchulmeister/ls-plugin-markdown#readme","repository":{"type":"git","url":"git+ssh://git@github.com/DennisSchulmeister/ls-plugin-markdown.git"},"author":{"name":"Dennis Schulmeister-Zimolong","email":"dennis@patk.org"},"bugs":{"url":"https://github.com/DennisSchulmeister/ls-plugin-markdown/issues"},"license":"AGPL-3.0","readme":"lecture-slides.js: Plugin for Markdown Syntax\n=============================================\n\nDescription\n-----------\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>\nLicensed under the 2-Clause BSD License.\n","readmeFilename":"README.md"}