Skip to content

Commit

Permalink
[ci skip] Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
yhatt committed Nov 19, 2022
1 parent 1f54e95 commit 561c1e4
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ Theme author does not have to worry an unintended design being used with unexpec

### Emoji support

Emoji shortcode (like `:smile:`) and Unicode emoji πŸ˜„ will convert into the SVG vector image provided by [twemoji](https://github.com/twitter/twemoji) <img src="https://twemoji.maxcdn.com/2/svg/1f604.svg" alt="πŸ˜„" width="16" height="16" />. It could render emoji with high resolution.
Emoji shortcode (like `:smile:`) and Unicode emoji πŸ˜„ will convert into the SVG vector image provided by [twemoji](https://github.com/twitter/twemoji) <img src="https://cdn.jsdelivr.net/gh/twitter/[email protected]/assets/svg/1f604.svg" alt="πŸ˜„" width="16" height="16" />. It could render emoji with high resolution.

---

Expand Down Expand Up @@ -275,14 +275,14 @@ Setting about emoji conversions.
- **`shortcode`**: _`boolean` | `"twemoji"`_
- By setting `false`, it does not convert any emoji shortcodes.
- By setting `true`, it converts emoji shortcodes into Unicode emoji. `:dog:` β†’ 🐢
- By setting `"twemoji"` string, it converts into twemoji vector image. `:dog:` β†’ <img src="https://twemoji.maxcdn.com/2/svg/1f436.svg" alt="🐢" width="16" height="16" valign="middle" /> _(default)_
- By setting `"twemoji"` string, it converts into twemoji vector image. `:dog:` β†’ <img src="https://cdn.jsdelivr.net/gh/twitter/[email protected]/assets/svg/1f436.svg" alt="🐢" width="16" height="16" valign="middle" /> _(default)_

* **`unicode`**: _`boolean` | `"twemoji"`_
- It can convert Unicode emoji into twemoji when setting `"twemoji"`. 🐢 β†’ <img src="https://twemoji.maxcdn.com/2/svg/1f436.svg" alt="🐢" width="16" height="16" valign="middle" /> _(default)_
- It can convert Unicode emoji into twemoji when setting `"twemoji"`. 🐢 β†’ <img src="https://cdn.jsdelivr.net/gh/twitter/[email protected]/assets/svg/1f436.svg" alt="🐢" width="16" height="16" valign="middle" /> _(default)_
- If you not want this aggressive conversion, please set `false`.

- **`twemoji`**: _`object`_
- **`base`**: _`string`_ - It is corresponded to [twemoji's `base` option](https://github.com/twitter/twemoji#object-as-parameter). By default, marp-core will use online emoji images [through MaxCDN (twemoji's default)](https://github.com/twitter/twemoji#cdn-support).
- **`base`**: _`string`_ - Corresponds to [twemoji's `base` option](https://github.com/twitter/twemoji#object-as-parameter). If not specified, Marp Core will use [online emoji images through jsDelivr CDN](https://cdn.jsdelivr.net/gh/twitter/twemoji@14.0.2/assets/svg/).
- **`ext`**: _`"svg"` | `"png"`_ - Setting the file type of twemoji images. _(`svg` by default)_

> **For developers:** When you setting `unicode` option as `true`, Markdown parser will convert Unicode emoji into tokens internally. The rendering result is same as in `false`.
Expand Down

0 comments on commit 561c1e4

Please sign in to comment.