MDBlog
VSCode插件,基于Markdown的轻量级静态博客系统,同时支持导出为可以部署的静态博客。
VSCode插件市场搜索MDBlog
安装即可使用。
仓库 MDBlog
0. 静态网址效果
首页
首页内容可全部编写markdown自定义,这里使用的Bing每日一图api作为图片展示
内容页面
- 点击标题名,返回首页
- 点击返回按钮,返回上一页
- 按下
~
打开侧边栏导航栏 - 图片可点击自动放大
- …
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
Enjoy!