外观
文档编写规范
提示
Obsidian中的显示格式会和实际的部署网页略有不同,比如手动的空行会被忽略,在这个提示框中的换行会被忽略,分割线的显示风格略有不同;这是由Obsidian不是纯血markdown语法,以及vuepress的主题风格共同造成的,不会对实际内容展示产生影响。但总之建议遵循传统Markdown语法书写
书写文档前
注意
务必务必务必确保右下角的分支为doc ,如果你在master分支,你的提交会被分支保护策略拒绝;但好在仓库默认分支是doc,并且正常工作流程中也不会出现切换分支的场景
警告
由于大家都在同一个分支上工作,务必务必不要改动其他人负责的内容,或者事先声明;Obsidian Git对冲突合并的支持非常之烂
提示
如果真的冲突了,左转VS Code,推荐一个插件叫Git Graph
正常的文档写作
创建文档
- 侧边栏中能观察到
docs/doc文件夹,你只要在其中建好合适的文件夹层级,然后在其中创建新的文件 - 本文件是写在博客中的只是因为方便打标签,以及让Blog看起来不那么空(
- 然后写就完事了,我想大部分时候也用不到什么高级语法
- 如果你想要把文档变的炫酷一点,或者有一些公式之类的高级表现形式需要呈现,你有以下两个帮手
- Markdown语法 我说Markdown>>Latex
- Plume Theme主题网站 里面记录了所有该主题支持的特性和语法
- 但话又说回来了,本地没有
Node.js和本地构建过的仓库环境高级特性也渲染不出来就是说(
文档元数据
- 你可以观测到比如说本文档中,在开头会有一些笔记属性
- 一般来说,如果是开着
pnpm docs:dev的网页开发模式写的或在本地构建了会自动加开头的一些属性 - 如果你本地没有
Node.js环境就不要管开头的属性了,远程构建的时候会自动添加的
添加链接
- Obsidian 有个非常好用的语法,双左中括号会展开一个下拉菜单选择链接,并且能自动转换成配置中的路径格式
图片
注意
不要传太大的图片,虽然这个仓库没有开LFS,但过大的图片会导致加载速度变慢
- 首先你需要在要添加图片的文档下新建
imgs文件夹(参见Obsidian本地设置) - 然后往里面丢图片,然后用链接指向它们
- 如果你需要图片显示在本文档之前,在链接前添加
!
示例

提交、PullRequest和部署
- 虽然Vercel很强大,但它的免费版每日只有100次部署额度,因此采用如下设计:
- 大家所有的写作都是在
doc分支进行的,随你怎么瞎jb提交都行,它不会触发部署 - 如果你本地装好了
Node.js环境,实际上你可以直接本地build了看(
- 大家所有的写作都是在
- 当
master分支更新之后,会自动触发部署 - 因此项目设置了针对
master的保护,只能以显式PullRequest的形式对其进行更新
- 当你需要触发部署时,你需要:
- 在GitHub仓库中打开Pull requests,然后将
base分支选择为master,compare分支选择为doc,然后Create pull request(一般来说都会是Able to merge的)
title和desp写点人话就行,文档仓库也不需要什么严格的提交信息
- 然后就应该在转转转之后能看见下图,选
Merge就行(文档仓库要什么Merge洁癖.jpg)
- 然后就没有人工队的事了,Vercel远程会自己部署的

更新日志
2026/3/13 16:01
查看所有更新日志
d79b6-docs: backup by Kisara at 2026-03-14 00:01:13于36510-docs: backup by Kisara at 2026-03-13 23:40:50于2a658-docs: backup by Kisara at 2026-03-13 23:20:30于4790a-docs: backup by Kisara at 2026-03-13 23:00:12于