Skip to content

如何发布新笔记

本文档将指导你如何在个人笔记站点中添加和发布新的文章。得益于项目的自动化配置,发布流程非常简单。

1. 创建 Markdown 文件

docs 目录下的对应分类文件夹中创建一个新的 .md 文件。

例如,如果你想写一篇关于 TypeScript 的技术笔记:

  1. 进入 docs/技术笔记/前端开发/ 目录。
  2. 创建文件 TypeScript入门.md
  3. 编写内容:
markdown
# TypeScript 入门

TypeScript 是 JavaScript 的超集...

## 基础类型

- boolean
- number
- string
...

提示:系统会自动读取文件中的一级标题(# Title)作为侧边栏显示的名称。

2. 自动配置说明

不需要 手动修改任何配置文件。

  • 侧边栏 (Sidebar):系统会自动检测新文件,并将其添加到左侧导航栏。
  • 首页卡片 (Features):如果你创建了一个全新的顶级分类目录(例如 docs/新分类/),下次启动开发服务器或构建时,首页会自动生成该分类的卡片。

3. 本地预览

在终端运行以下命令,系统会自动更新索引并启动预览:

bash
npm run docs:dev

访问 http://localhost:5173/notes/ 查看效果。

4. 部署上线

确认无误后,将更改推送到 GitHub,GitHub Actions 会自动处理构建和部署:

bash
git add .
git commit -m "feat: add new article about typescript"
git push

稍等几分钟,访问你的 GitHub Pages 地址即可看到更新。

Released under the MIT License.