{"id":13536819,"url":"https://github.com/markdown-it/markdown-it-emoji","last_synced_at":"2025-10-07T20:35:44.336Z","repository":{"id":24871530,"uuid":"28287262","full_name":"markdown-it/markdown-it-emoji","owner":"markdown-it","description":"Emoji syntax plugin for markdown-it markdown parser","archived":false,"fork":false,"pushed_at":"2025-09-04T17:07:51.000Z","size":249,"stargazers_count":754,"open_issues_count":8,"forks_count":174,"subscribers_count":7,"default_branch":"master","last_synced_at":"2025-10-04T22:32:26.058Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://markdown-it.github.io/","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/markdown-it.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":"support/update.mjs","governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2014-12-21T03:33:23.000Z","updated_at":"2025-09-22T03:26:34.000Z","dependencies_parsed_at":"2023-12-25T01:08:54.211Z","dependency_job_id":"bf528f1e-85f1-4f51-8a03-564fea5805cf","html_url":"https://github.com/markdown-it/markdown-it-emoji","commit_stats":{"total_commits":75,"total_committers":8,"mean_commits":9.375,"dds":0.2533333333333333,"last_synced_commit":"bdd07260f080e4d3d812928f3eb0b00883e4e71b"},"previous_names":[],"tags_count":14,"template":false,"template_full_name":null,"purl":"pkg:github/markdown-it/markdown-it-emoji","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/markdown-it%2Fmarkdown-it-emoji","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/markdown-it%2Fmarkdown-it-emoji/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/markdown-it%2Fmarkdown-it-emoji/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/markdown-it%2Fmarkdown-it-emoji/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/markdown-it","download_url":"https://codeload.github.com/markdown-it/markdown-it-emoji/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/markdown-it%2Fmarkdown-it-emoji/sbom","scorecard":{"id":619866,"data":{"date":"2025-08-11","repo":{"name":"github.com/markdown-it/markdown-it-emoji","commit":"bdd07260f080e4d3d812928f3eb0b00883e4e71b"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":4.2,"checks":[{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Code-Review","score":1,"reason":"Found 3/28 approved changesets -- score normalized to 1","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/markdown-it/markdown-it-emoji/ci.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/markdown-it/markdown-it-emoji/ci.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci.yml:32: update your workflow using https://app.stepsecurity.io/secureworkflow/markdown-it/markdown-it-emoji/ci.yml/master?enable=pin","Warn: npmCommand not pinned by hash: .github/workflows/ci.yml:27","Info:   0 out of   2 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   1 third-party GitHubAction dependencies pinned","Info:   0 out of   1 npmCommand dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/ci.yml:1","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"Security-Policy","score":10,"reason":"security policy file detected","details":["Info: security policy file detected: github.com/markdown-it/.github/SECURITY.md:1","Info: Found linked content: github.com/markdown-it/.github/SECURITY.md:1","Info: Found disclosure, vulnerability, and/or timelines in security policy: github.com/markdown-it/.github/SECURITY.md:1","Info: Found text in security policy: github.com/markdown-it/.github/SECURITY.md:1"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 5 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}}]},"last_synced_at":"2025-08-21T04:56:48.625Z","repository_id":24871530,"created_at":"2025-08-21T04:56:48.625Z","updated_at":"2025-08-21T04:56:48.625Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":278532892,"owners_count":26002458,"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","status":"online","status_checked_at":"2025-10-05T02:00:06.059Z","response_time":54,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":[],"created_at":"2024-08-01T09:00:50.002Z","updated_at":"2025-10-07T20:35:44.286Z","avatar_url":"https://github.com/markdown-it.png","language":"JavaScript","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"readme":"# markdown-it-emoji\n\n[![CI](https://github.com/markdown-it/markdown-it-emoji/actions/workflows/ci.yml/badge.svg)](https://github.com/markdown-it/markdown-it-emoji/actions/workflows/ci.yml)\n[![NPM version](https://img.shields.io/npm/v/markdown-it-emoji.svg?style=flat)](https://www.npmjs.org/package/markdown-it-emoji)\n[![Coverage Status](https://coveralls.io/repos/markdown-it/markdown-it-emoji/badge.svg?branch=master\u0026service=github)](https://coveralls.io/github/markdown-it/markdown-it-emoji?branch=master)\n\n\u003e Plugin for [markdown-it](https://github.com/markdown-it/markdown-it) markdown parser, adding emoji \u0026 emoticon syntax support. Also supports emoticons [shortcuts](https://github.com/markdown-it/markdown-it-emoji/blob/master/lib/data/shortcuts.js) like `:)`, `:-(`, and others.\n\n__NOTE. v3 changed exports, see below.__\n\n\n## Install\n\n```bash\nnpm install markdown-it-emoji\n```\n\n## Use\n\n### init\n\n```js\n//\n// { full, light, bare } configs available.\n//\n//  full:  includes all available emojis support\n//  light: includes small subset of most useable emojis\n//  bare:  no defaults\n//\n// Also CJS \u0026 UMD builds available in `dist/` folder of published package,\n// if your env not supports ESM modules use.\n//\nimport { full as emoji } from 'markdown-it-emoji'\nimport markdownit from 'markdown-it'\n\nconst md = markdownit().use(emoji/* , options */);\n```\n\nOptions are not mandatory:\n\n- __defs__ (Object) - rewrite available emoji definitions\n  - example: `{ name1: char1, name2: char2, ... }`\n- __enabled__ (Array) - disable all emojis except whitelisted\n- __shortcuts__ (Object) - rewrite default shortcuts\n  - example: `{ \"smile\": [ \":)\", \":-)\" ], \"laughing\": \":D\" }`\n\n_Differences in browser._ If you load the script directly into the page without\nusing a package system, the module will add itself globally with the name `markdownitEmoji`.\n\n### change output\n\nBy default, emojis are rendered as appropriate unicode chars. But you can change\nthe renderer function as you wish.\n\nRender as span blocks (for example, to use a custom iconic font):\n\n```js\n// ...\n// initialize\n\nmd.renderer.rules.emoji = function(token, idx) {\n  return '\u003cspan class=\"emoji emoji_' + token[idx].markup + '\"\u003e\u003c/span\u003e';\n};\n```\n\nOr use [twemoji](https://github.com/twitter/twemoji):\n\n```js\n// ...\n// initialize\n\nimport twemoji from 'twemoji'\n\nmd.renderer.rules.emoji = function(token, idx) {\n  return twemoji.parse(token[idx].content);\n};\n```\n\n__NB 1__. Read [twemoji docs](https://github.com/twitter/twemoji#string-parsing)!\nIn case you need more options to change image size \u0026 type.\n\n__NB 2__. When using twemoji you can make image height match the line height with this\nstyle:\n\n```css\n.emoji {\n  height: 1.2em;\n}\n```\n\n### In your markdown file\n\n```md\nHello from mars :satellite:\n```\n\nbecomes\n\n```\nHello from mars 📡\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmarkdown-it%2Fmarkdown-it-emoji","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmarkdown-it%2Fmarkdown-it-emoji","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmarkdown-it%2Fmarkdown-it-emoji/lists"}