MDBlog
VSCode插件,基于Markdown的輕量級靜態博客系統,同時支持導出為可以部署的靜態博客。
倉庫 MDBlog
1. Features
- 博客基礎功能:分類管理、文章管理、自動生成索引
- 快捷指令:快捷輸入表格、mermaid、wavedrom、代碼塊
- 發布:將Markdown發布為HTML文件
- (可選) 本地預覽功能:基于live-server支持本地預覽發布的HTML文件
2. Tip
- 如果需要使用本地服務預覽,請先安裝
Node.js
,然后安裝使用命令npm install -g live-server
來安裝live-server
, - 建議配合插件 [Markdown Preview Enhanced] 使用,vscode編寫md即可預覽,編寫完成后發布為靜態博客
- ! 警告:如果您使用Windows,請不要在C盤建立MDBlog的文件夾,由于權限問題,會導致某些功能無法使用。
- 不要在
<do-not-delete-me>
標簽內編寫內容,或者刪除它,會導致MDB的無法自動生成索引
3. Quick Start
3.1 MDBlog初始化
- 初始化
然后根據提示輸入博客名和作者(使用英文逗號分割)
- 輸入信息
3.2 新建、編輯、刪除分類
-
新建一級分類
-
新建次級分類,次級分類可以繼續新建下一級分類
-
刪除、重命名分類
-
移動分類
-
復制目標分類的地址
-
移動 -> 粘貼目標分類地址
-
3.3 新建、編輯、刪除文章
- 新建文章
其他同分類操作
3.4 發布和預覽
-
發布Markdown文件為HTML文件
- 發布:發布當前編輯器的md文件
- 更新發布:發布已經保存的md文件
- 全部發布:發布全部md文件
-
本地服務預覽HTML文件(請確保已經安裝Node.js和live-server)
- 啟動:啟動live-server
- 停止:停止live-server
- 查看(默認瀏覽器):使用默認瀏覽器打開發布的靜態博客
-
直接預覽HTML文件(不需要安裝Node.js和live-server)
- [發布] -> [右擊] -> [打開發布(資源管理器)] -> 雙擊打開首頁index.html
3.5 快捷命令
MDBlog支持快捷命令,輸入mc.
即彈出提示框。
Tip: 為了便于MDBlog管理圖片,請務必使用快捷命令插入圖片和刪除圖片
- 插入圖片
- 復制你要粘貼的圖片
- 新行輸入命令
mc.insert_img
回車 - 粘貼圖片,MDBlog自動管理圖片和生成新索引
- 刪除圖片
- 光標放在圖片格式前后位置,不可在中間
- 輸入命令
mc.delete_img
回車 - MDBlog自動刪除圖片和相關索引
- 新建表格
- 新行按如下格式
行數, 列數, 對齊方式
輸入需要的表格,使用英文逗號 - 行數和列數都是數字,對齊方式可選
l
左對齊,c
居中對齊,r
右對齊 - 例如輸入
2,3,c
,緊接著輸入mc.insert_table回車 - 自動生成2行3列,居中對齊的表格
- 新行按如下格式
- 插入代碼塊
- 新行輸入需要的語言,例如
c
或者java
- 緊接著輸入
mc.insert_code_block
回車 - 自動生成對應的代碼塊
- 新行輸入需要的語言,例如
- 插入mermaid
- 新行輸入
mc.insert_mermaid_xxx
命令,即可生成對應的mermaid示例
- 新行輸入
- 插入wavedrom
- 新行輸入
mc.insert_wavedrom_xxx
命令,即可生成對應的wavedrom示例{signal: [{name: 'clk', wave: 'p..Pp..P'},,['Master',,['ctrl',{name: 'write', wave: '01.0....'},{name: 'read', wave: '0...1..0'}],{name: 'addr', wave: 'x3.x4..x', data: 'A1 A2'},{name: 'wdata', wave: 'x3.x....', data: 'D1' },]] }
- 新行輸入
4. Keybindings
功能 | 快捷鍵 |
---|---|
初始化New MDBlog | ctrl+m i |
打開New MDBlog | ctrl+m o |
全部發布 | ctrl+p a |
更新發布 | ctrl+p s |
發布(當前編輯) | ctrl+p c |
查看網頁(默認瀏覽器) | ctrl+p o |
本地預覽-啟動 | ctrl+m s |
本地預覽-停止 | ctrl+m t |
5. Release Notes
1.0.1 (24.03.02)
基礎版本:基礎博客功能
6. For more information
- 本插件基于crossnote開發
7. License
License
Enjoy!