Skip to content

Commit 887b29c

Browse files
committed
feat: add gemoji plugin
1 parent 2c9221e commit 887b29c

File tree

4 files changed

+65
-0
lines changed

4 files changed

+65
-0
lines changed

packages/bytemd/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -162,6 +162,7 @@ The 2,5,7 steps are designed for user customization via ByteMD plugin API.
162162
| [@bytemd/plugin-external-links](./packages/plugin-external-links) | [![npm](https://img.shields.io/npm/v/@bytemd/plugin-external-links.svg)](https://npm.im/@bytemd/plugin-external-links) [![gzip size](https://img.badgesize.io/https://unpkg.com/@bytemd/plugin-external-links/dist/index.min.js?compression=gzip)](https://unpkg.com/@bytemd/plugin-external-links) | Open external links in new window |
163163
| [@bytemd/plugin-footnotes](./packages/plugin-footnotes) | [![npm](https://img.shields.io/npm/v/@bytemd/plugin-footnotes.svg)](https://npm.im/@bytemd/plugin-footnotes) [![gzip size](https://img.badgesize.io/https://unpkg.com/@bytemd/plugin-footnotes/dist/index.min.js?compression=gzip)](https://unpkg.com/@bytemd/plugin-footnotes) | Support footnotes |
164164
| [@bytemd/plugin-frontmatter](./packages/plugin-frontmatter) | [![npm](https://img.shields.io/npm/v/@bytemd/plugin-frontmatter.svg)](https://npm.im/@bytemd/plugin-frontmatter) [![gzip size](https://img.badgesize.io/https://unpkg.com/@bytemd/plugin-frontmatter/dist/index.min.js?compression=gzip)](https://unpkg.com/@bytemd/plugin-frontmatter) | Parse frontmatter |
165+
| [@bytemd/plugin-gemoji](./packages/plugin-gemoji) | [![npm](https://img.shields.io/npm/v/@bytemd/plugin-gemoji.svg)](https://npm.im/@bytemd/plugin-gemoji) [![gzip size](https://img.badgesize.io/https://unpkg.com/@bytemd/plugin-gemoji/dist/index.min.js?compression=gzip)](https://unpkg.com/@bytemd/plugin-gemoji) | Support Gemoji shortcodes |
165166
| [@bytemd/plugin-gfm](./packages/plugin-gfm) | [![npm](https://img.shields.io/npm/v/@bytemd/plugin-gfm.svg)](https://npm.im/@bytemd/plugin-gfm) [![gzip size](https://img.badgesize.io/https://unpkg.com/@bytemd/plugin-gfm/dist/index.min.js?compression=gzip)](https://unpkg.com/@bytemd/plugin-gfm) | Support GFM (autolink literals, strikethrough, tables, tasklists) |
166167
| [@bytemd/plugin-highlight](./packages/plugin-highlight) | [![npm](https://img.shields.io/npm/v/@bytemd/plugin-highlight.svg)](https://npm.im/@bytemd/plugin-highlight) [![gzip size](https://img.badgesize.io/https://unpkg.com/@bytemd/plugin-highlight/dist/index.min.js?compression=gzip)](https://unpkg.com/@bytemd/plugin-highlight) | Highlight code blocks |
167168
| [@bytemd/plugin-highlight-ssr](./packages/plugin-highlight-ssr) | [![npm](https://img.shields.io/npm/v/@bytemd/plugin-highlight-ssr.svg)](https://npm.im/@bytemd/plugin-highlight-ssr) [![gzip size](https://img.badgesize.io/https://unpkg.com/@bytemd/plugin-highlight-ssr/dist/index.min.js?compression=gzip)](https://unpkg.com/@bytemd/plugin-highlight-ssr) | Highlight code blocks (SSR compatible) |

packages/plugin-gemoji/README.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# @bytemd/plugin-gemoji
2+
3+
[![npm](https://img.shields.io/npm/v/@bytemd/plugin-gemoji.svg)](https://npm.im/@bytemd/plugin-gemoji)
4+
5+
ByteMD plugin to support Gemoji shortcodes
6+
7+
## Usage
8+
9+
```js
10+
import { Editor } from 'bytemd';
11+
import gemoji from '@bytemd/plugin-gemoji';
12+
13+
new Editor({
14+
target: document.body,
15+
props: {
16+
plugins: [
17+
gemoji(),
18+
// ... other plugins
19+
],
20+
},
21+
});
22+
```
23+
24+
## License
25+
26+
MIT
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
{
2+
"name": "@bytemd/plugin-gemoji",
3+
"version": "0.2.0",
4+
"description": "ByteMD plugin to support Gemoji shortcodes",
5+
"author": "Rongjian Zhang <[email protected]>",
6+
"license": "MIT",
7+
"repository": {
8+
"type": "git",
9+
"url": "https://github.com/bytedance/bytemd.git",
10+
"directory": "packages/plugin-gemoji"
11+
},
12+
"main": "dist/index.js",
13+
"module": "dist/index.esm.js",
14+
"unpkg": "dist/index.min.js",
15+
"types": "lib/index.d.ts",
16+
"files": [
17+
"dist",
18+
"lib"
19+
],
20+
"dependencies": {
21+
"remark-gemoji": "^6.0.0"
22+
},
23+
"peerDependencies": {
24+
"bytemd": "*"
25+
},
26+
"publishConfig": {
27+
"access": "public"
28+
}
29+
}
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
import type { BytemdPlugin } from 'bytemd';
2+
// @ts-ignore
3+
import remarkGemoji from 'remark-gemoji';
4+
5+
export default function gemoji(): BytemdPlugin {
6+
return {
7+
remark: (u) => u.use(remarkGemoji),
8+
};
9+
}

0 commit comments

Comments
 (0)