Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/halo-sigs/plugin-bytemd
为 Halo 2.0 集成 ByteMD 编辑器
https://github.com/halo-sigs/plugin-bytemd
bytemd halo halo-plugin markdown markdown-editor
Last synced: 3 days ago
JSON representation
为 Halo 2.0 集成 ByteMD 编辑器
- Host: GitHub
- URL: https://github.com/halo-sigs/plugin-bytemd
- Owner: halo-sigs
- License: gpl-3.0
- Created: 2022-12-08T07:35:06.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-07-05T08:38:40.000Z (5 months ago)
- Last Synced: 2024-12-09T03:39:45.624Z (4 days ago)
- Topics: bytemd, halo, halo-plugin, markdown, markdown-editor
- Language: Vue
- Homepage: https://halo.run/store/apps/app-HTyhC
- Size: 2.16 MB
- Stars: 14
- Watchers: 2
- Forks: 6
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-halo - plugin-bytemd - 为 Halo 2.0 集成 ByteMD 编辑器 (Halo 2.0 / 插件)
README
# plugin-bytemd
集成 [bytemd](https://github.com/bytedance/bytemd) 到 Halo。
## 使用方式
1. 下载，目前提供以下两个下载方式：
- GitHub Releases：访问 [Releases](https://github.com/halo-sigs/plugin-bytemd/releases) 下载 Assets 中的 JAR 文件。
- Halo 应用市场：。
2. 安装，插件安装和更新方式可参考：。
3. 安装完成之后，进入文章新建页面即可在右上角编辑器切换按钮中看到 ByteMD 编辑器。
## 常见问题
1. 如何支持编写数学公式
目前此插件已经支持编写数学公式，但需要同时安装 [plugin-katex](https://github.com/halo-sigs/plugin-katex) 插件才能够正常在编辑器预览区域渲染。另外，还需要在 KaTeX 插件设置中设置 dom 节点才能够在文章中正常渲染，可以参考：
## 开发环境
```bash
git clone [email protected]:halo-sigs/plugin-bytemd.git
# 或者当你 fork 之后
git clone [email protected]:{your_github_id}/plugin-bytemd.git
```
```bash
cd path/to/plugin-bytemd
```
```bash
# macOS / Linux
./gradlew pnpmInstall
# Windows
./gradlew.bat pnpmInstall
```
```bash
# macOS / Linux
./gradlew build
# Windows
./gradlew.bat build
```
修改 Halo 配置文件：
```yaml
halo:
plugin:
runtime-mode: development
classes-directories:
- "build/classes"
- "build/resources"
lib-directories:
- "libs"
fixedPluginPath:
- "/path/to/plugin-bytemd"
```