oceanpress_old下載oceanpress

oceanpress_old

網站數據

v0.5.4_tested_on_siyuan_docker_v1.7.11

下載

這個項目已經停止維護

現在推薦使用新版https://github.com/siyuan-note/oceanpress

OceanPress

將MarkDown 文件轉換為html 的靜態站點

點擊這裡查看生成後的效果靜態文件位於gh-pages

搭配hexo 的效果

思源1.2.5 改動了目錄名為文檔id，這之前的版本請使用siyuan-note/oceanpress v0.4.4
注意！思源1.2 存在一個比較大的改動，這之前的版本請使用siyuan-note/oceanpress at b6185cd79f

運行方式run

下載地址只需下載所用平台的二進製文件與views.zip 就可以了

平台	命令	備註
Windows	`.md2website-windows-4.0-amd64.exe 参数`
Linux	`.md2website-linux-amd64 参数`
Mac	`.md2website-darwin-10.6-amd64 参数`	我沒有嘗試過，因為我沒有mac
源碼	`go run .src 参数`

參數

參數名	值	示例
SourceDir	是筆記所在目錄	C:/Users/llej/Documents/SiYuan/data/note
OutDir	是你要輸出的目錄	D:/code/doc/docHTML
viewDir	之前下載的view.zip 解壓後的目錄，可以自行修改其中的文件來定制一些效果	./views/
SqlitePath	是思源生成的db 文件的路徑	C:/Users/llej/AppData/Local/Temp/siyuan/siyuan.db
RssNoOutputHtml	對於後綴為.rss.xml的文檔不輸出對應的html	true（默認值）

示例：

❯ ./md2website-windows-4.0-amd64.exe -SourceDir C:/Users/llej/Documents/SiYuan/data/note -OutDir D:/code/doc/docHTML -TemplateDir D:/code/oceanpress/src/views -SqlitePath C:/Users/llej/AppData/Local/Temp/siyuan/siyuan.db

# 运行输出

0. === ? 开始转换 ? ===
1. 用户输入
   1.1 sourceDir:C: U sers l lej D ocuments S iYuan d ata n ote
   1.2 outDir:D: c ode d oc d ocHTML
   1.3 viewsDir:D: c ode o ceanpress s rc v iews
   1.4 dbPath:C: U sers l lej A ppData L ocal T emp s iyuan s iyuan.db
   1.5 AssetsDir:C: U sers l lej D ocuments S iYuan d ata a ssets
2. copy 资源到 outDir
   2.1 copy 完成
3. 生成 html
   3.1 收集转换生成所需数据
   3.2 复制资源文件
   3.3 从文件到数据结构转换完毕，开始生成html,共 293 项
   [warn] 未找到id 20210104102607-1rhjb41 对应的fileEntity
   [warn] 未找到id 20210511124801-bhveys4 对应的fileEntity
   ----- End -----

待完成的功能點（按優先級降序排序）

下面很久沒有更新了，請點擊此鏈接查看更新記錄

可用	功能名	大致進度
✅	#6 內容塊動態查詢渲染	`80%`
❎?	#4 菜單頁面美化	`15%`
✅?	#2 嵌入塊渲染目前不支持循環引用	`60%`
⭕	目錄樹
⭕	頁面header 與footer
⭕	塊引用當前頁面預覽
⭕	塊鏈接可copy
⭕	書籤頁
⭕	標籤頁
✅?	#8 反鏈	`50%`
✅?	#1 塊引用鏈接	`92%`
	支持{.text} 這樣的錨文本。思源1.2後已經不再支持	`100%`
✅	#3 代碼高亮以及數學公式和腦圖等渲染點擊這裡查看生成後的效果還需要修改vditor 等資源的引用為本地文件（不是很重要之後再說）	`100%`

✅ 表示基本可以使用了
? 表示還在修改中
❎ 表示有一小部分功能可以使用了但還存在比較大的問題
表示不可用
⭕ 表示尚未開始

開發

整體設計

渲染

自定義渲染器在./src/render/ocean_press_render_custom.go 下
- render 目錄下的其他文件均是從lute 項目中copy 過來的

/front-end-lib

這個目錄下是一個使用svelte 的前端項目，目的是為了提供前端技術上的支持

這個項目主要的思路是提供自定義組件的js 文件，然後在html 的模板中就直接使用自定義組件的標籤了，這樣方便用戶替換其中的一些實現。

目前生成的資源有：

js 文件	描述	體積
all_components	包含了所有組件	266KB
block-ref.web_components	塊引用組件	4KB
embedded-block.web_components	嵌入塊組件	5KB
md.web_components.js	文檔渲染組件因為引入了vditor 所以稍微有點大	263KB