{"_id":"@aetherinox/marked-alert-fa","_rev":"11-31747990891fb0a1acd375b51e56e775","time":{"created":"2024-04-26T01:42:28.790Z","2.0.1":"2024-04-25T21:15:23.287Z","modified":"2024-04-27T08:23:51.452Z","0.0.1":"2024-04-25T21:42:50.385Z","2.0.2":"2024-04-26T00:46:52.319Z","2.0.3":"2024-04-26T01:42:29.069Z","2.0.4":"2024-04-26T13:45:05.201Z","2.0.5":"2024-04-27T08:23:51.264Z"},"name":"@aetherinox/marked-alert-fa","dist-tags":{"latest":"2.0.5"},"versions":{"2.0.3":{"name":"@aetherinox/marked-alert-fa","version":"2.0.3","description":"Marked extension which displays Github-like alerts with font-awesome 6","publishConfig":{"access":"public"},"homepage":"https://github.com/Aetherinox/marked-alert-fa","author":{"name":"Aetherinox","email":"adminservx@proton.me"},"license":"MIT","contributors":[{"name":"Aetherinox","email":"adminservx@proton.me","url":"https://github.com/Aetherinox"},{"name":"AdminServ","email":"adminservx@proton.me","url":"https://github.com/AdminServ"},{"name":"Beni Arisandi","url":"https://stilearning.com"}],"repository":{"type":"git","url":"git+https://github.com/Aetherinox/marked-alert-fa.git"},"bugs":{"url":"https://github.com/Aetherinox/marked-alert-fa/issues"},"keywords":["marked","marked-extension","gfm","alert","font-awesome","fontawesome","notes"],"type":"module","main":"./dist/index.cjs","browser":"./dist/index.umd.js","module":"./dist/index.js","types":"./dist/index.d.ts","exports":{".":{"import":"./dist/index.js","require":"./dist/index.cjs","types":"./dist/index.d.ts"}},"scripts":{"start":"vite","dev":"vite build --watch","build":"vite build && npm run types","test":"vitest","coverage":"vitest run --coverage","types":"tsc -d --emitDeclarationOnly --outDir ./dist","lint":"tsc --noEmit && eslint . --cache --cache-location ../../node_modules/.eslint","format":"prettier . --write --cache-location ../../node_modules/.prettier --ignore-path ../../.prettierignore"},"peerDependencies":{"marked":">=8.0.0"},"_id":"@aetherinox/marked-alert-fa@2.0.3","gitHead":"948693cdcc3e9b44b38519761bd0bd50eacdd3e5","_nodeVersion":"20.12.2","_npmVersion":"10.5.0","dist":{"integrity":"sha512-9tliULYXXDi+SIlVyffPYcb6xtYZRGjH4VR6zHPRIK5LYHoNUGygpGSjCx+0sF6n1h/oJ7n1f5N5irIIR+oeHw==","shasum":"fb7556d13889672f434896394e50c89dbd51b7c8","tarball":"https://registry.npmjs.org/@aetherinox/marked-alert-fa/-/marked-alert-fa-2.0.3.tgz","fileCount":9,"unpackedSize":18743,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCnRNzCtPOOV+rJNTll5rzwZQDH9hKHNvQdmsdrZItNRAIgBYQSqi1h8Hbwl32kvLkRSui+/6cfET3LX3KB4q46qXU="}]},"_npmUser":{"name":"aetherinox","email":"aetherinox@proton.me"},"directories":{},"maintainers":[{"name":"aetherinox","email":"aetherinox@proton.me"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/marked-alert-fa_2.0.3_1714095748892_0.5037257503707566"},"_hasShrinkwrap":false},"2.0.4":{"name":"@aetherinox/marked-alert-fa","version":"2.0.4","description":"Marked extension which displays Github-like alerts with font-awesome 6","publishConfig":{"access":"public"},"homepage":"https://github.com/Aetherinox/marked-alert-fa","author":{"name":"Aetherinox","email":"adminservx@proton.me"},"license":"MIT","contributors":[{"name":"Aetherinox","email":"adminservx@proton.me","url":"https://github.com/Aetherinox"},{"name":"AdminServ","email":"adminservx@proton.me","url":"https://github.com/AdminServ"},{"name":"Beni Arisandi","url":"https://stilearning.com"}],"repository":{"type":"git","url":"git+https://github.com/Aetherinox/marked-alert-fa.git"},"bugs":{"url":"https://github.com/Aetherinox/marked-alert-fa/issues"},"keywords":["marked","marked-extension","gfm","alert","font-awesome","fontawesome","notes"],"type":"module","main":"./dist/index.cjs","browser":"./dist/index.umd.js","module":"./dist/index.js","types":"./dist/index.d.ts","exports":{".":{"import":"./dist/index.js","require":"./dist/index.cjs","types":"./dist/index.d.ts"}},"scripts":{"start":"vite","dev":"vite build --watch","build":"vite build && npm run types","test":"vitest","coverage":"vitest run --coverage","types":"tsc -d --emitDeclarationOnly --outDir ./dist","lint":"tsc --noEmit && eslint . --cache --cache-location ../../node_modules/.eslint","format":"prettier . --write --cache-location ../../node_modules/.prettier --ignore-path ../../.prettierignore"},"peerDependencies":{"marked":">=8.0.0"},"_id":"@aetherinox/marked-alert-fa@2.0.4","gitHead":"6d132bd3effcec6be5a0036f4fe056cbdc356c74","_nodeVersion":"20.12.2","_npmVersion":"10.5.0","dist":{"integrity":"sha512-LrLeZUCspPIqaxosLYVPWIZRq6v6wt84yZuPb8MG3r0crsA0FGlXuVMHKd7n6YdGtAA3582ohVbhMV6W9H4ORQ==","shasum":"ea1a31b9968020295c0350439c41434a2c7d90ba","tarball":"https://registry.npmjs.org/@aetherinox/marked-alert-fa/-/marked-alert-fa-2.0.4.tgz","fileCount":9,"unpackedSize":18773,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIHC/81LnsYDtFsaS40IlqihhhOqKTHNUOCUBjCINlovlAiBolGUi1Nh1PQwMDySIjSPW/goFoXg4vzp2GLsnDSDcWw=="}]},"_npmUser":{"name":"aetherinox","email":"aetherinox@proton.me"},"directories":{},"maintainers":[{"name":"aetherinox","email":"aetherinox@proton.me"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/marked-alert-fa_2.0.4_1714139105038_0.9538729433166402"},"_hasShrinkwrap":false},"2.0.5":{"name":"@aetherinox/marked-alert-fa","version":"2.0.5","description":"Marked extension which displays Github-like alerts with font-awesome 6","publishConfig":{"access":"public"},"homepage":"https://github.com/Aetherinox/marked-alert-fa","author":{"name":"Aetherinox","email":"adminservx@proton.me"},"license":"MIT","contributors":[{"name":"Aetherinox","email":"adminservx@proton.me","url":"https://github.com/Aetherinox"},{"name":"AdminServ","email":"adminservx@proton.me","url":"https://github.com/AdminServ"},{"name":"Beni Arisandi","url":"https://stilearning.com"}],"repository":{"type":"git","url":"git+https://github.com/Aetherinox/marked-alert-fa.git"},"bugs":{"url":"https://github.com/Aetherinox/marked-alert-fa/issues"},"keywords":["marked","marked-extension","gfm","alert","font-awesome","fontawesome","notes"],"type":"module","main":"./dist/index.cjs","browser":"./dist/index.umd.js","module":"./dist/index.js","types":"./dist/index.d.ts","exports":{".":{"import":"./dist/index.js","require":"./dist/index.cjs","types":"./dist/index.d.ts"}},"scripts":{"start":"vite","dev":"vite build --watch","build":"vite build && npm run types","test":"vitest","coverage":"vitest run --coverage","types":"tsc -d --emitDeclarationOnly --outDir ./dist","lint":"tsc --noEmit && eslint . --cache --cache-location ../../node_modules/.eslint","format":"prettier . --write --cache-location ../../node_modules/.prettier --ignore-path ../../.prettierignore"},"peerDependencies":{"marked":">=8.0.0"},"_id":"@aetherinox/marked-alert-fa@2.0.5","gitHead":"00ee8299dd360d11c3d487a3383811ba0bd4e759","_nodeVersion":"20.12.2","_npmVersion":"10.5.0","dist":{"integrity":"sha512-w4PNixu6WYJPFLm2OzECm7PuXpYZoFqOtPPCQclUKlltwxq5ysBut34kdZm7vtD8nXAQWw6pViUhb/7Kg/bgFA==","shasum":"f4c3ff8efab18d0aa645d13920d0a02d426bcfc2","tarball":"https://registry.npmjs.org/@aetherinox/marked-alert-fa/-/marked-alert-fa-2.0.5.tgz","fileCount":9,"unpackedSize":22436,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIA5OHW4uZJTh1mCw0VoFxt74fbRLiyULQ6nPHOuzbFrLAiEA+H5Gx2zw6iPxeO0Jx9UrbJJBHcwbabP7qR8cvDWWyJY="}]},"_npmUser":{"name":"aetherinox","email":"aetherinox@proton.me"},"directories":{},"maintainers":[{"name":"aetherinox","email":"aetherinox@proton.me"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/marked-alert-fa_2.0.5_1714206231124_0.7110361748728935"},"_hasShrinkwrap":false}},"maintainers":[{"name":"aetherinox","email":"aetherinox@proton.me"}],"description":"Marked extension which displays Github-like alerts with font-awesome 6","homepage":"https://github.com/Aetherinox/marked-alert-fa","keywords":["marked","marked-extension","gfm","alert","font-awesome","fontawesome","notes"],"repository":{"type":"git","url":"git+https://github.com/Aetherinox/marked-alert-fa.git"},"contributors":[{"name":"Aetherinox","email":"adminservx@proton.me","url":"https://github.com/Aetherinox"},{"name":"AdminServ","email":"adminservx@proton.me","url":"https://github.com/AdminServ"},{"name":"Beni Arisandi","url":"https://stilearning.com"}],"author":{"name":"Aetherinox","email":"adminservx@proton.me"},"bugs":{"url":"https://github.com/Aetherinox/marked-alert-fa/issues"},"license":"MIT","readme":"
\n

marked-alert-fa ⚠️

\n
\n

This package is a fork of marked-alert; however, it utilizes font-awesome icon IDs for the notifications instead of svg paths.

\n\n
\n\n\n[![Test Status][badge-tests]][link-tests]\n[![Code Coverage][badge-coverage]][link-coverage]\n[![Last Commit][badge-commit]][badge-commit]\n[![Size][badge-size-gh]][badge-size-gh]\n[![All Contributors][badge-all-contributors]](#contributors-)\n\n\n
\n\n
\n\n---\n\n
\n\n## About\n`marked-alert-fa` is an extension of [marked-alert](https://www.npmjs.com/package/marked-alert) which allows you to display github-like alerts within markdown.\n\nFor this package to run, you must have [marked](https://www.npmjs.com/package/marked) installed. This package however, does not require marked-alert. It is stand-alone.\n\nYou must have some form of Font-Awesome implemented in your project. The easiest way is to install the node package [@fortawesome/fontawesome-free](https://www.npmjs.com/package/@fortawesome/fontawesome-free)\n\nWhile the original package utilizes SVG paths for the fonts; this package utilizes font-awesome path IDs.\n\nThe following icons are utilized by default:\n\n
\n\n| Alert ID | Icon |\n| --- | --- |\n| Note | |\n| Tip | |\n| Important | |\n| Warning | |\n| Caution | |\n\n
\n\n---\n\n
\n\n\n- [About](#about)\n- [Install](#install)\n- [Usage](#usage)\n- [Options](#options)\n - [Default Alert Variants](#default-alert-variants)\n- [Updates](#updates)\n- [Related Packages:](#related-packages)\n- [Contributors ✨](#contributors-)\n\n
\n\n---\n\n
\n\n## Install\n\nYou can install `marked-alert-fa` using npm or yarn:\n\n```bash\nnpm i @Aetherinox/marked-alert-fa\n# or\nyarn add @Aetherinox/marked-alert\n```\n\n
\n\n---\n\n
\n\n## Usage\n\nThese alerts are similar to the ones utilized on Github:\n\n> [!NOTE]\n> This is a note\n\n> [!TIP]\n> This is a tip\n\n> [!IMPORTANT]\n> This is important\n\n> [!WARNING]\n> This is a warning\n\n> [!CAUTION]\n> This is a caution\n\n
\n\nTo get these icons to display within alerts, utilize [marked](https://www.npmjs.com/package/marked) to convert your markdown. You may use an example similar to the following:\n\n
\n\n\n\n```md\n# Example\n\n> [!NOTE]\n> Highlights information that users should take into account, even when skimming.\n\n> [!TIP]\n> Optional information to help a user be more successful.\n\n> [!IMPORTANT]\n> Crucial information necessary for users to succeed.\n\n> [!WARNING]\n> Critical content demanding immediate user attention due to potential risks.\n\n> [!CAUTION]\n> Negative potential consequences of an action.\n```\n\n
\n\nWithin your `.js` file, utilize something similar to:\n\n
\n\n```js\nimport { readFileSync } from 'node:fs'\nimport { Marked } from 'marked'\nimport markedAlertFa from '@aetherinox/marked-alert-fa';\n\nconst html = new Marked()\n .use(markedAlertFa())\n .parse(readFileSync('example.md', 'utf8'))\n\nconsole.log(html)\n```\n\n
\n\nAfter marked does its work, you should have the following output::\n\n```html\n

Example

\n
\n

Note

\n

Highlights information that users should take into account, even when skimming.

\n
\n
\n

Tip

\n

Optional information to help a user be more successful.

\n
\n
\n

Important

\n

Crucial information necessary for users to succeed.

\n
\n
\n

Warning

\n

Critical content demanding immediate user attention due to potential risks.

\n
\n
\n

Caution

\n

Negative potential consequences of an action.

\n
\n```\n\n
\n\nYou can also include `setOptions` and define other extensions, and call `parse()` separately.\n\n```js\nimport { Marked } from 'marked';\nimport markedAlertFa from '@aetherinox/marked-alert-fa';\n\n const html = new Marked()\n .setOptions({\n renderer: new YourRenderer(),\n breaks: true,\n gfm: true,\n tables: true\n })\n .use(markedAlertFa())\n .use(markedFootnote())\n .parse(readFileSync('example.md', 'utf8'));\n\n console.log(html)\n```\n\n---\n\n
\n\n## Options\n\nThe `markedAlertFa` extension accepts the same options as [markedAlert](https://www.npmjs.com/package/marked-alert):\n\n- `className`: A string representing a custom CSS class for the alerts.\n- `variants`: An array of alert variants, where each variant is configured with a type, icon, and title class name. This allows you to create different alert types.\n\n
\n\n### Default Alert Variants\n\nThe extension includes default alert variants:\n\n- `[!NOTE]`: Highlights information that users should take into account, even when skimming.\n- `[!TIP]`: Optional information to help a user be more successful.\n- `[!IMPORTANT]`: Crucial information necessary for users to succeed.\n- `[!WARNING]`: Critical content demanding immediate user attention due to potential risks.\n- `[!CAUTION]`: Negative potential consequences of an action.\n\n
\n\nEach variant has an associated icon and title class name which is shown in the [About](#about) section above.\n\nYou can customize the default alert variants and add your own.\n\n```js\nconst options = {\n variants: [\n {\n type: 'danger',\n icon: 'clipboard',\n title: 'Hello world', // optional\n titleClassName: 'text-danger' // optional\n }\n ]\n}\n```\n\n
\n\nThe major different between this package and [markedAlert](https://www.npmjs.com/package/marked-alert) is that the `icon` field accepts only [Font Awesome](https://fontawesome.com/v6/icons?q=note&o=r&m=free) IDs. The reason for this was due to how our software it set up, and the end-user not having the ability to create their own calls in the back-end.\n\n
\n\nYou can get the ID of an icon by going to the font-awesome website at https://fontawesome.com/v6/icons?q=note&o=r&m=free.\n\nSelect an icon and copy the font tag to the right of the icon.\n\n
\n\n

\n\n
\n\nIn the example above, you would copy `file-circle-check`, and leave the `fa` off.\n\n
\n\n```js\nconst options = {\n variants: [\n {\n type: 'success',\n icon: 'file-circle-check',\n title: 'File Uploaded',\n titleClassName: 'text-danger'\n }\n ]\n}\n```\n\n
\n\n---\n\n
\n\n## Updates\nThis was originally developed for one software title. If others find it useful, I'll update it and add additional things.\n\n
\n\n---\n\n
\n\n## Related Packages:\n- [MarkedJS](https://github.com/markedjs/marked)\n- [Marked-Alert](https://www.npmjs.com/package/marked-alert)\n- [Marked Extensions List](https://github.com/bent10/marked-extensions#packages)\n\n
\n\n---\n\n
\n\n## Contributors ✨\nWe are always looking for contributors. If you feel that you can provide something useful to this package, then we'd love to review your suggestion. Before submitting your contribution, please review the following resources:\n\n- [Pull Request Procedure](https://github.com/Aetherinox/marked-alert-fa/tree/main/.github/PULL_REQUEST_TEMPLATE.md)\n- [Contributor Policy](CONTRIBUTING.md)\n\n
\n\nWant to help but can't write code?\n- Review [active questions by our community](https://github.com/Aetherinox/marked-alert-fa/labels/help%20wanted) and answer the ones you know.\n\n
\n\nThe following people have helped get this project going:\n\n\n[![Contributors][badge-all-contributors]](#contributors-)\n\n\n\n\n\n\n \n \n \n \n \n
\"Aetherinox\"/
Aetherinox
💻 📆 🔍
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
\n\n---\n\n
\n\n\n\n[link-general-npm]: https://npmjs.com\n[link-general-nodejs]: https://nodejs.org\n[link-npmtrends]: http://npmtrends.com/@aetherinox/marked-alert-fa\n\n[badge-version-gh]: https://img.shields.io/github/v/tag/Aetherinox/marked-alert-fa?logo=GitHub&label=Version&color=ba5225\n[link-version-gh]: https://github.com/Aetherinox/marked-alert-fa/releases\n\n[badge-version-npm]: https://img.shields.io/npm/v/@aetherinox/marked-alert-fa?logo=npm&label=Version&color=ba5225\n[link-version-npm]: https://npmjs.com/package/@aetherinox/marked-alert-fa\n\n[badge-license-mit]: https://img.shields.io/badge/MIT-FFF?logo=creativecommons&logoColor=FFFFFF&label=License&color=9d29a0\n[link-license-mit]: https://github.com/Aetherinox/marked-alert-fa/blob/main/LICENSE\n\n[badge-build]: https://img.shields.io/github/actions/workflow/status/Aetherinox/marked-alert-fa/release-npm.yml?logo=github&logoColor=FFFFFF&label=Build&color=%23278b30\n[link-build]: https://github.com/Aetherinox/marked-alert-fa/actions/workflows/release-npm.yml\n\n[badge-downloads-gh]: https://img.shields.io/github/downloads/Aetherinox/marked-alert-fa/total?logo=github&logoColor=FFFFFF&label=Downloads&color=376892\n[link-downloads-gh]: https://github.com/Aetherinox/marked-alert-fa/releases\n[badge-downloads-npm]: https://img.shields.io/npm/dw/%40aetherinox%2Fmarked-alert-fa?logo=npm&&label=Downloads&color=376892\n[link-downloads-npm]: https://npmjs.com/package/@aetherinox/marked-alert-fa\n\n[badge-size-gh]: https://img.shields.io/github/repo-size/Aetherinox/marked-alert-fa?logo=github&label=Size&color=59702a\n[link-size-gh]: https://github.com/Aetherinox/marked-alert-fa/releases\n[badge-size-npm]: https://img.shields.io/npm/unpacked-size/@aetherinox/marked-alert-fa/latest?logo=npm&label=Size&color=59702a\n[link-size-npm]: https://npmjs.com/package/@aetherinox/marked-alert-fa\n\n[badge-coverage]: https://img.shields.io/codecov/c/github/Aetherinox/marked-alert-fa?token=MPAVASGIOG&logo=codecov&logoColor=FFFFFF&label=Coverage&color=354b9e\n[link-coverage]: https://codecov.io/github/Aetherinox/marked-alert-fa\n\n[badge-all-contributors]: https://img.shields.io/github/all-contributors/Aetherinox/marked-alert-fa?logo=contributorcovenant&color=de1f6f&label=contributors\n[link-all-contributors]: https://github.com/all-contributors/all-contributors\n[badge-tests]: https://img.shields.io/github/actions/workflow/status/Aetherinox/marked-alert-fa/npm-tests.yml?logo=github&label=Tests&color=2c6488\n[link-tests]: https://github.com/Aetherinox/marked-alert-fa/actions/workflows/tests.yml\n[badge-commit]: https://img.shields.io/github/last-commit/Aetherinox/marked-alert-fa?logo=conventionalcommits&logoColor=FFFFFF&label=Last%20Commit&color=313131\n[link-commit]: https://github.com/Aetherinox/marked-alert-fa/commits/main/\n\n","readmeFilename":"README.md"}