Skip to content

Commit

Permalink
doc: Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jaywcjlove committed Mar 15, 2024
1 parent a68b7f8 commit 096d0f8
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@ remark-github-alert
<!--rehype:style=display: flex; height: 230px; align-items: center; justify-content: center; font-size: 38px;-->

[![Buy me a coffee](https://img.shields.io/badge/Buy%20me%20a%20coffee-048754?logo=buymeacoffee)](https://jaywcjlove.github.io/#/sponsor)
[![Downloads](https://img.shields.io/npm/dm/rehype-github-alert.svg?style=flat)](https://www.npmjs.com/package/rehype-github-alert)
[![NPM version](https://img.shields.io/npm/v/rehype-github-alert.svg?style=flat)](https://npmjs.org/package/rehype-github-alert)
[![Build](https://github.com/jaywcjlove/rehype-github-alert/actions/workflows/ci.yml/badge.svg)](https://github.com/jaywcjlove/rehype-github-alert/actions/workflows/ci.yml)
[![Coverage Status](https://jaywcjlove.github.io/rehype-github-alert/badges.svg)](https://jaywcjlove.github.io/rehype-github-alert/lcov-report/)
[![Repo Dependents](https://badgen.net/github/dependents-repo/jaywcjlove/rehype-github-alert)](https://github.com/jaywcjlove/rehype-github-alert/network/dependents)
[![Downloads](https://img.shields.io/npm/dm/remark-github-alert.svg?style=flat)](https://www.npmjs.com/package/remark-github-alert)
[![NPM version](https://img.shields.io/npm/v/remark-github-alert.svg?style=flat)](https://npmjs.org/package/remark-github-alert)
[![CI](https://github.com/jaywcjlove/remark-github-alert/actions/workflows/ci.yml/badge.svg)](https://github.com/jaywcjlove/remark-github-alert/actions/workflows/ci.yml)
[![Coverage Status](https://jaywcjlove.github.io/remark-github-alert/badges.svg)](https://jaywcjlove.github.io/remark-github-alert/lcov-report/)
[![Repo Dependents](https://badgen.net/github/dependents-repo/jaywcjlove/remark-github-alert)](https://github.com/jaywcjlove/remark-github-alert/network/dependents)

Remark plugin to add support for [GitHub Alert](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#alerts)

Expand All @@ -18,13 +18,13 @@ Alerts are a Markdown extension based on the blockquote syntax that you can use
This package is [ESM only](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c): Node 12+ is needed to use it and it must be `import` instead of `require`.

```bash
npm install rehype-github-alert
npm install remark-github-alert
```

## Usage

```js
import plugin from 'rehype-github-alert'
import plugin from 'remark-github-alert'

const html = String(
await remark().use(remarkParse).use(plugin).use(remarkRehype).use(rehypeStringify).process(`\
Expand Down

0 comments on commit 096d0f8

Please sign in to comment.