# hexo-blockquote2note

> A Hexo plugin that renders blockquotes to note tags of NexT theme.

Latest version **1.2.1** (published 2024-05-22) · GPL-3.0-or-later license · 0 weekly downloads

## Install

```sh
npm install hexo-blockquote2note
pnpm add hexo-blockquote2note
yarn add hexo-blockquote2note
bun add hexo-blockquote2note
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.2.1 |
| Published | 2024-05-22 |
| First published | 2024-02-02 |
| Weekly downloads | 0 |
| License | GPL-3.0-or-later |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 37.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | BlockLune |
| Maintainers | blocklune |
| Keywords | hexo, next-theme |

## Links

- npm: https://www.npmjs.com/package/hexo-blockquote2note
- Repository: https://github.com/BlockLune/hexo-blockquote2note
- Issues: https://github.com/BlockLune/hexo-blockquote2note/issues
- npm.io page: https://npm.io/package/hexo-blockquote2note

## Dependencies (1)

- [hexo](https://npm.io/package/hexo.md) ^7.2.0

## Alternatives

- [postcss-color-hex-alpha](https://npm.io/package/postcss-color-hex-alpha.md) — 6.4M weekly downloads
- [randomcolor](https://npm.io/package/randomcolor.md) — 348.0K weekly downloads
- [bows](https://npm.io/package/bows.md) — 1.3K weekly downloads
- [ep_prefer_color_scheme](https://npm.io/package/ep_prefer_color_scheme.md) — 260 weekly downloads
- [coc-yank](https://npm.io/package/coc-yank.md) — 61 weekly downloads

## Recent versions

- 1.2.1 (latest) — 2024-05-22
- 1.1.1 — 2024-02-03
- 1.0.0 — 2024-02-02

## README

# hexo-blockquote2note

A Hexo plugin that renders blockquotes to [the note tag of the NexT theme](https://theme-next.js.org/docs/tag-plugins/note).

You may first edit your `_config.next.yml` to enable all features of the note tag. For example, this is mine:

```yaml
note:
  style: flat
  icons: true
```

## Syntax

Surround the blockquotes that you want to transform to notes with `<!--blockquote2note-->` (HEAD) and `<!--end-blockquote2note-->` (TAIL), and they will be rendered as the note tags.

For example:

```md
<!--blockquote2note-->

> This is an example blockquote.

<!--end-blockquote2note-->
```

will be rendered as:

```md
{% note %}
This is an example blockquote.
{% endnote %}
```

Configuration is supported.

For example:

```md
<!--blockquote2note:default,no-icon,Test-->

> This is an example blockquote.

<!--end-blockquote2note-->
```

will be rendered as:

```md
{% note default no-icon Test %}
This is Line 1 of this blockquote.
{% endnote %}
```

After v1.1.0, purely blank lines between HEAD and TAIL are allowed. So it's also OK to use like:

```md
<!--blockquote2note-->

> This is an example.

<!--end-blockquote2note-->
```

> [!IMPORTANT] > **Keep those commas**, even if an option is empty.  
> For example: `<!--blockquote2note:,,Test-->`.

> [!CAUTION]
> Nested blockquotes are NOT supported.

## Installation

```bash
npm install hexo-blockquote2note --save
```

## Development

### Setup

```bash
git clone --depth=1 git@github.com:BlockLune/hexo-blockquote2note.git
pnpm install
```

### Test

```bash
pnpm test
```

> [!CAUTION]
> Node v21 may not show correct line numbers in stack traces when testing. See [this](https://github.com/BlockLune/hexo-blockquote2note/issues/1) issue.

---
_Source: https://npm.io/package/hexo-blockquote2note · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
