Twemoji 开源项目使用教程

最新推荐文章于 2024-09-13 08:59:37 发布

顾淑慧Beneficient

最新推荐文章于 2024-09-13 08:59:37 发布

阅读量269

点赞数 4

本文链接：https://blog.csdn.net/gitblog_00571/article/details/141149228

版权

Twemoji 开源项目使用教程

twemojiEmoji for everyone. https://twemoji.twitter.com/项目地址:https://gitcode.com/gh_mirrors/tw/twemoji

1. 项目的目录结构及介绍

Twemoji 项目的目录结构如下：

twemoji/
├── LICENSE
├── README.md
├── build
│   ├── 36x36
│   ├── 72x72
│   └── ...
├── dist
│   ├── twemoji.min.js
│   └── ...
├── docs
│   └── ...
├── scripts
│   └── ...
├── src
│   ├── 16x16
│   ├── 36x36
│   └── ...
├── test
│   └── ...
└── package.json

LICENSE: 项目许可证文件。
README.md: 项目说明文档。
build: 构建生成的文件，包含不同尺寸的 emoji 图片。
dist: 分发文件，包含编译后的 JavaScript 文件。
docs: 项目文档。
scripts: 构建和测试脚本。
src: 源代码，包含不同尺寸的 emoji 图片源文件。
test: 测试文件。
package.json: 项目配置文件，包含依赖和脚本命令。

2. 项目的启动文件介绍

Twemoji 项目的启动文件主要是 dist/twemoji.min.js，这是编译后的 JavaScript 文件，用于在网页中解析和显示 emoji。

使用方法如下：

<script src="https://unpkg.com/twemoji@14.0.2/dist/twemoji.min.js" integrity="sha384-ICOlZarapRIX6UjKPcWKEpubjg7lGADN7Y9fYP4DU9zm0aPFhgnP5ef+XFaPyKv+" crossorigin="anonymous"></script>
<script>
  twemoji.parse(document.body);
</script>

这段代码会在页面加载时解析并替换所有的 emoji 为 Twemoji 图片。

3. 项目的配置文件介绍

Twemoji 项目的主要配置文件是 package.json，其中包含了项目的元数据、依赖和脚本命令。

{
  "name": "twemoji",
  "version": "14.0.2",
  "description": "A Unicode standard based emoji library",
  "main": "dist/twemoji.npm.js",
  "scripts": {
    "test": "npm run build && mocha",
    "build": "node scripts/build.js"
  },
  "repository": {
    "type": "git",
    "url": "git+https://github.com/twitter/twemoji.git"
  },
  "keywords": [
    "emoji",
    "DOM",
    "parser",
    "images",
    "retina",
    "Twitter",
    "unicode"
  ],
  "author": "Twitter, Inc.",
  "license": "MIT",
  "bugs": {
    "url": "https://github.com/twitter/twemoji/issues"
  },
  "homepage": "https://github.com/twitter/twemoji#readme",
  "devDependencies": {
    "chai": "^4.2.0",
    "mocha": "^6.2.2",
    "puppeteer": "^1.20.0"
  }
}

name: 项目名称。
version: 项目版本。
description: 项目描述。
main: 入口文件。
scripts: 脚本命令，如 test 和 build。
repository: 项目仓库地址。
keywords: 项目关键词。
author: 项目作者。
license: 项目许可证。
devDependencies: 开发依赖。