{"id":19098675,"url":"https://github.com/bloggify/showdown-emoji","last_synced_at":"2025-04-30T15:26:36.099Z","repository":{"id":22236410,"uuid":"95683751","full_name":"Bloggify/showdown-emoji","owner":"Bloggify","description":":yum: A Showdown extension for replacing emoji codes with images.","archived":false,"fork":false,"pushed_at":"2022-03-15T12:07:26.000Z","size":51,"stargazers_count":3,"open_issues_count":0,"forks_count":2,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-19T04:42:24.347Z","etag":null,"topics":["bloggify","emoji","hacktoberfest","markdown","showdown","showdown-extension"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Bloggify.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-06-28T15:22:50.000Z","updated_at":"2022-03-15T12:07:23.000Z","dependencies_parsed_at":"2022-08-07T10:01:38.736Z","dependency_job_id":null,"html_url":"https://github.com/Bloggify/showdown-emoji","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Bloggify%2Fshowdown-emoji","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Bloggify%2Fshowdown-emoji/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Bloggify%2Fshowdown-emoji/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Bloggify%2Fshowdown-emoji/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Bloggify","download_url":"https://codeload.github.com/Bloggify/showdown-emoji/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251730786,"owners_count":21634451,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bloggify","emoji","hacktoberfest","markdown","showdown","showdown-extension"],"created_at":"2024-11-09T03:47:03.478Z","updated_at":"2025-04-30T15:26:36.053Z","avatar_url":"https://github.com/Bloggify.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003c!-- Please do not edit this file. Edit the `blah` field in the `package.json` instead. If in doubt, open an issue. --\u003e\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n# showdown-emoji\n\n [![Version](https://img.shields.io/npm/v/showdown-emoji.svg)](https://www.npmjs.com/package/showdown-emoji) [![Downloads](https://img.shields.io/npm/dt/showdown-emoji.svg)](https://www.npmjs.com/package/showdown-emoji)\n\n\n\n\n\n\n\n\u003e A Showdown extension for replacing emoji codes with images.\n\n\n\n\n\n\nThis package uses [GitHub Emoji APIs](https://developer.github.com/v3/emojis/) to display the emojis in [Showdown](https://github.com/showdownjs/showdown) HTML outputs. :tada:\n\n\n\n\n\n\n\n\n\n\n\n\n## :cloud: Installation\n\n```sh\n# Using npm\nnpm install --save showdown-emoji\n\n# Using yarn\nyarn add showdown-emoji\n```\n\n\n\n\n\n\n\n\n\n\n\n\n\n## :clipboard: Example\n\n\n\n```js\nconst showdown = require('showdown')\n    , showdownEmoji = require(\"showdown-emoji\")\n    ;\n\n// After requiring the module, use it as extension\nlet converter = new showdown.Converter({\n    extensions: [showdownEmoji]\n});\n\n// Now you can Emoji code blocks\nlet html = converter.makeHtml(\"Hello World! :heart:\");\n\nconsole.log(html);\n// \u003cp\u003eHello World! \u003cimg src=\"https://github.global.ssl.fastly.net/images/icons/emoji/heart.png?v5\" alt=\":heart:\" title=\":heart:\" class=\"emoji-img emoji\"\u003c/p\u003e\n```\n\n\n\n\n\n\n\n\n\n\n\n## :question: Get Help\n\nThere are few ways to get help:\n\n\n\n 1. Please [post questions on Stack Overflow](https://stackoverflow.com/questions/ask). You can open issues with questions, as long you add a link to your Stack Overflow question.\n 2. For bug reports and feature requests, open issues. :bug:\n\n\n\n\n\n## :memo: Documentation\n\n\n### `showdownEmoji(emojiDirPath)`\nReplace the :emojis: in the text with images.\n\n#### Params\n\n- **String** `emojiDirPath`: The public path to the emoji directory containing the emoji images. (default: `\"/emojis\"`)\n\n#### Return\n- **Array** The configuration used by Showdown.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n## :yum: How to contribute\nHave an idea? Found a bug? See [how to contribute][contributing].\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n## :dizzy: Where is this library used?\nIf you are using this library in one of your projects, add it in this list. :sparkles:\n\n - `mdpdf`\n - `bloggify-emoji`\n - `docbook`\n - `@penciljs/core`\n\n\n\n\n\n\n\n\n\n\n\n## :scroll: License\n\n[MIT][license] © [Bloggify][website]\n\n\n\n\n\n\n[license]: /LICENSE\n[website]: https://bloggify.org\n[contributing]: /CONTRIBUTING.md\n[docs]: /DOCUMENTATION.md\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbloggify%2Fshowdown-emoji","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbloggify%2Fshowdown-emoji","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbloggify%2Fshowdown-emoji/lists"}