小站手记

用 Obsidian 写下第一篇博客

从一份 Markdown 开始:建立文章文件夹、填写文章信息、插入图片,再把准备好的内容发布到小站。

打开博客专用仓库 #

在 Obsidian 中选择「打开文件夹作为仓库」,打开项目里的 src/content 文件夹。

这里是博客的写作空间。posts 放文章,projects 放项目介绍,spec/about.md 是关于页。日记、密码和私人资料放在另一个 Obsidian 仓库。

新建一篇文章 #

在 posts 下创建一个名字简短的英文文件夹,例如 uart-notes,然后在其中创建 index.md。文章地址会是 /posts/uart-notes/,尽量在发布后保持文件夹名字稳定。

从 _templates 中复制文章模板,或者在 Obsidian 命令面板中使用「模板:插入模板」。文件开头的信息可以这样写:

---
title: 我的第一篇学习笔记
published: 2026-10-11
draft: true
description: 用一两句话说明这篇笔记讲什么。
category: 学习笔记
tags: [STM32, 串口]
image: ""
---

draft: true 表示草稿。 草稿不会出现在首页、搜索、RSS 和公开文章地址中。遗漏 draft 也会按草稿处理,准备好公开时再明确改成 false。

published 使用 YYYY-MM-DD 日期。即使日期写在未来,只要 draft 为 false 就会发布;它不是定时发布开关。

使用熟悉的 Markdown #

标题、列表、表格和代码块都可以直接写。代码块注明语言,例如 c、cpp、python,网页就会显示语法高亮和复制按钮。

下面只是一段用来展示阅读排版的 C 代码:

#include <stdint.h>
// 示例:给一个计数值加一
uint32_t increment(uint32_t value) {
return value + 1U;
}

提示框可以使用 Obsidian 的常见写法:

留下能复现的过程

写调试笔记时,记录环境、现象、尝试和最后的原因,会比只记一个结论更有用。

内容建议记录什么
环境开发板、工具链和软件版本
现象预期结果与实际结果
过程测量、日志和尝试过的方案
结论原因、解决方法和仍未确定的问题

公式也可以使用标准 Markdown 数学语法,例如 f=1/Tf = 1 / T。多行公式单独放在双美元符号之间。

放入图片与链接 #

图片放在文章自己的 images 子文件夹,使用标准相对链接:

![开发板接线示意](./images/wiring.png)
[欢迎页](../welcome/index.md)

Obsidian 的双链、插件按钮和特殊数据库视图,并不都能在网站中使用。公开文章优先使用标准 Markdown 链接,不依赖额外插件。

预览以后,再提交 #

写好后先保存,在本地网页检查排版和图片。准备发布时把 draft 改成 false,再运行项目的验证命令:

Terminal window
pnpm verify

检查通过后,手动提交并推送到 GitHub。Cloudflare Pages 连接好仓库以后,会根据新的提交自动构建网站。

只在明确准备公开时执行 Git 的提交和同步操作。Obsidian Git 的自动提交、自动推送和启动拉取都保持关闭。更详细的账号与首次上传步骤见项目里的 docs 目录。