📃 docs(readme): 更新渲染器开发文档

siyuan-note · May 22, 2021 · 4afce87 · 4afce87
1 parent 1a87379
commit 4afce87
Showing 1 changed file with 7 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -57,7 +57,7 @@
 
 | 可用 | 功能名                                                                                                                                                                                                                                                                                                                             | 大致进度 |
 | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------- |
-| ✅   | [#6 内容块动态查询渲染](https://github.com/siyuan-note/oceanpress/issues/6)                                                                                                                                                                                                                                                        | `70%`    |
+| ✅   | [#6 内容块动态查询渲染](https://github.com/siyuan-note/oceanpress/issues/6)                                                                                                                                                                                                                                                        | `80%`    |
 | ❎🔨 | [#4 菜单页面美化](https://github.com/siyuan-note/oceanpress/issues/4)                                                                                                                                                                                                                                                              | `15%`    |
 | ✅🔨 | [#2 嵌入块渲染](https://github.com/siyuan-note/oceanpress/issues/2) 目前不支持循环引用                                                                                                                                                                                                                                             | `60%`    |
 | ⭕   | 目录树                                                                                                                                                                                                                                                                                                                             |          |
@@ -68,7 +68,7 @@
 | ⭕   | 标签页                                                                                                                                                                                                                                                                                                                             |          |
 | ✅🔨 | [#8 反链](https://github.com/siyuan-note/oceanpress/issues/8)                                                                                                                                                                                                                                                                      | `50%`    |
 | ✅🔨 | [#1 块引用链接](https://github.com/siyuan-note/oceanpress/issues/1)                                                                                                                                                                                                                                                                | `92%`    |
-| ❌   | 支持 {.text} 这样的锚文本<br />思源1.2后已经不再支持                                                                                                                                                                                                                                                                               | `100%`   |
+| ❌   | 支持 {.text} 这样的锚文本。<br />思源1.2后已经不再支持                                                                                                                                                                                                                                                                             | `100%`   |
 | ✅   | [#3 代码高亮 以及 数学公式和脑图等渲染](https://github.com/siyuan-note/oceanpress/issues/3) [点击这里查看生成后的效果](https://siyuan-note.github.io/oceanpress/Markdown%20%e4%bd%bf%e7%94%a8%e6%8c%87%e5%8d%97/3%20%e5%ae%8c%e6%95%b4%e7%a4%ba%e4%be%8b.html)<br />还需要修改 vditor 等资源的引用为本地文件（不是很重要之后再说） | `100%`   |
 
 1. ✅ 表示基本可以使用了
@@ -89,6 +89,11 @@
 
 ![整体设计](./整体设计导图.png)
 
+### 渲染
+
+- 自定义渲染器在 ./src/render/ocean_press_render_custom.go 下
+  - render 目录下的其他文件均是从 lute 项目中 copy 过来的
+
 ### /font-end-lib
 
 > 这个目录下是一个使用 svelte 的前端项目，目的是为了提供前端技术上的支持