{"id":13536591,"url":"https://github.com/theme-next/hexo-filter-emoji","last_synced_at":"2025-07-17T03:32:22.835Z","repository":{"id":90598533,"uuid":"184297275","full_name":"theme-next/hexo-filter-emoji","owner":"theme-next","description":"🎉 GitHub emojis for Hexo!","archived":false,"fork":false,"pushed_at":"2021-05-09T21:33:17.000Z","size":28,"stargazers_count":11,"open_issues_count":3,"forks_count":1,"subscribers_count":8,"default_branch":"master","last_synced_at":"2025-05-22T11:28:50.591Z","etag":null,"topics":[],"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/theme-next.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2019-04-30T16:37:33.000Z","updated_at":"2023-07-25T14:25:30.000Z","dependencies_parsed_at":"2023-04-11T05:32:20.319Z","dependency_job_id":null,"html_url":"https://github.com/theme-next/hexo-filter-emoji","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/theme-next/hexo-filter-emoji","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/theme-next%2Fhexo-filter-emoji","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/theme-next%2Fhexo-filter-emoji/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/theme-next%2Fhexo-filter-emoji/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/theme-next%2Fhexo-filter-emoji/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/theme-next","download_url":"https://codeload.github.com/theme-next/hexo-filter-emoji/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/theme-next%2Fhexo-filter-emoji/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265563018,"owners_count":23788631,"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":[],"created_at":"2024-08-01T09:00:45.054Z","updated_at":"2025-07-17T03:32:22.816Z","avatar_url":"https://github.com/theme-next.png","language":"JavaScript","funding_links":[],"categories":["Plugins"],"sub_categories":["Hexo Plugins"],"readme":"# hexo-filter-emoji\n\n[![Npm Version](https://img.shields.io/npm/v/hexo-filter-emoji?style=flat-square)](https://npmjs.org/package/hexo-filter-emoji)\n[![Npm Downloads Month](https://img.shields.io/npm/dm/hexo-filter-emoji?style=flat-square)](https://npmjs.org/package/hexo-filter-emoji)\n[![Npm Downloads Total](https://img.shields.io/npm/dt/hexo-filter-emoji?style=flat-square)](https://npmjs.org/package/hexo-filter-emoji)\n[![License](https://img.shields.io/npm/l/hexo-filter-emoji?style=flat-square)](https://npmjs.org/package/hexo-filter-emoji)\n\nA Hexo plugin that adds emoji support, using [Github Emojis API](https://api.github.com/emojis).\n\nCheck out the [Emoji Cheat Sheet](http://www.webpagefx.com/tools/emoji-cheat-sheet/) for all the emojis it supports.\n\n## Installation\n\n``` bash\n$ npm install hexo-filter-emoji\n```\n\n## Options\n\nYou can configure this plugin in Hexo `_config.yml`. Default options:\n\n``` yaml\nemoji:\n  enable: true\n  className: github-emoji\n  styles:\n  customEmojis:\n```\n\n- **className** - Image class name. For example :sparkles: `:sparkles:` the filter will generate something like this:\n\n  ```html\n  \u003cspan class=\"github-emoji\" style=\"background-image: url(https://assets-cdn.github.com/images/icons/emoji/unicode/2728.png?v8)\" data-src=\"https://assets-cdn.github.com/images/icons/emoji/unicode/2728.png?v8\"\u003e\u0026#x2728;\u003c/span\u003e\n  ```\n\n- **styles** - inline styles. For example:\n\n  ```yaml\n  emoji:\n    styles:\n      font-size: 2em\n      font-weight: bold\n  ```\n\n  outputs:\n\n  ```html\n  \u003cspan class=\"github-emoji\" style=\"font-size: 2em; font-weight: bold; background-image: url(...)\" ...\u003e\n  ```\n\n- **customEmojis** - You can specify your own list. An object or JSON string is valid. The filter will first check the `customEmojis` then fallback to the [Github Emojis][ghemojis] list.\n\n  For example:\n\n  ```yaml\n  emoji:\n    customEmojis:\n      arrow_left: https://path/to/arrow_left.png\n      arrow_right: https://path/to/arrow_right.png\n  ```\n\n  If you need to add code points that are not in the Github list, you can do this:\n\n  ```yaml\n  emoji:\n    customEmojis:\n      man_juggling:\n        src: https://path/to/man_juggling.png\n        codepoints: [\"1f939\", \"2642\"]\n      arrow_right: https://path/to/arrow_right.png\n  ```\n\n## Tag\n\nIf you do not like the `::`-style keywords, you can always use tags:\n\n```html\n{% emoji sparkles %}\n```\n\nAdd `no-emoji: true` to front-matter to stop replacing `::`:\n\n```md\n---\ntitle: Hello World\nno-emoji: true\n---\n\n:tada: as it is.\n\n{% emoji tada %} still works.\n```\n\n## Helper\n\nYou can also render a GitHub emoji from a template using the `emoji` helper:\n\n```html\n\u003ch1\u003e{% emoji('octocat') %}\u003c/h1\u003e\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftheme-next%2Fhexo-filter-emoji","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftheme-next%2Fhexo-filter-emoji","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftheme-next%2Fhexo-filter-emoji/lists"}