https://github.com/halo-sigs/plugin-hybrid-edit-block

为默认富文本编辑器提供编写 Markdown / HTML 的内容块扩展
https://github.com/halo-sigs/plugin-hybrid-edit-block

halo halo-plugin plugin tiptap

Last synced: 3 days ago
JSON representation

为默认富文本编辑器提供编写 Markdown / HTML 的内容块扩展

• Host: GitHub
• URL: https://github.com/halo-sigs/plugin-hybrid-edit-block
• Owner: halo-sigs
• License: gpl-3.0
• Created: 2023-10-23T03:39:42.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-07-05T08:44:39.000Z (5 months ago)
• Last Synced: 2024-11-02T09:31:58.478Z (about 1 month ago)
• Topics: halo, halo-plugin, plugin, tiptap
• Language: TypeScript
• Homepage: https://www.halo.run/store/apps/app-NgHnY
• Size: 620 KB
• Stars: 8
• Watchers: 3
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-halo - plugin-hybrid-edit-block - 为默认富文本编辑器提供编写 Markdown / HTML 的内容块扩展 (Halo 2.0 / 插件)
• awesome-tiptap - Markdown / HTML Content Block by Halo - Insert HTML and Markdown blocks into the editor

README

        
# 默认富文本编辑器的 Markdown / HTML 内容块扩展

本插件是 Halo 默认富文本编辑器的扩展插件，允许你在默认编辑器中插入 `HTML` 及 `Markdown` 块，用于撰写 HTML 或 Markdown 代码。

## 预览

### HTML 编辑块

![HTML Editor](./img/html-editor.png)

### Markdown 编辑块

![Markdown edit block](./img/markdown-editor.png)

## 用法

1. 在 [Halo](https://www.halo.run/) 中安装此插件并启用

2. 在编辑器中点击 `+` 按钮，或者使用 `/` 快捷键, 选择 `HTML` 或 `Markdown` 编辑块

    ![Insert edit block](./img/insert-editor.png)

3. 在 `HTML` 或 `Markdown` 编辑块中编写代码

4. 点击 `保存` 按钮，即可在文章中看到效果

## 开发

1. fork 此仓库

    ```bash

    https://github.com/halo-sigs/plugin-hybrid-edit-block/fork

    ```

2. 克隆自己的分支到本地

    ```#55c6a0

    git clone https://github.com/{you-name}/plugin-hybrid-edit-block

    ```

3. 安装依赖

    ```#55c6a0

    cd path/to/plugin-hybrid-edit-block/console 

    pnpm install

    pnpm dev

    ```

4. 打包最终产物

    ```#55c6a0

    ./gradlew clean build

    ```

## 常见问题

1. 是否支持 `style` 及 `script` 标签？

支持。但建议编写时将作用范围限制在较小范围内。

2. Markdown 编辑块中的回显内容与编写时的语法不一致？

由于 Markdown 编辑器最终产物是 HTML，因此回显的内容是基于 HTML 根据规则反解析的，因此可能与编写时的语法不一致。例如

```

* First item

* Second item

* Third item

* Fourth item

```

回显之后将会变成

```

- First item

- Second item

- Third item

- Fourth item

```

3. 停止使用此插件之后，之前编辑的内容会丢失吗？

之前编辑的内容不会丢失，但由于没有了插件支持，将无法正常显示。