Skip to content

Latest commit

 

History

History
45 lines (34 loc) · 2.7 KB

File metadata and controls

45 lines (34 loc) · 2.7 KB

开发文档索引

本目录存放工程的开发、维护和部署说明。根目录 README.md 是唯一的项目介绍;本索引及其下的编号文档面向需要修改代码、内容或构建流程的开发者。

快速入口

文档 适用场景 内容
开发环境与常用命令 第一次运行项目 Node.js、pnpm、Astro、Sveltia CMS 和检查命令
工程结构与模块职责 定位代码和入口 目录职责、路由、数据流和路径别名
文章与内容开发 新建或编辑文章 Sveltia CMS、Frontmatter、文章目录、图片和 Markdown 扩展
站点配置与主题定制 修改站点外观和行为 站点、导航、个人资料、主题色、Banner 和 i18n
构建、检查与部署 发布前检查或部署 构建产物、CI、站点 URL、静态部署和预览
私人博客使用指南 将模板用于个人博客 初始化、配置、写作、草稿、发布、备份和隐私边界

相关资料:

推荐阅读顺序

  1. 开发环境与常用命令
  2. 工程结构与模块职责
  3. 根据任务阅读文章与内容开发站点配置与主题定制
  4. 发布前阅读构建、检查与部署
  5. 作为个人博客使用时阅读私人博客使用指南

工程概览

  • 技术栈:Astro 5、Svelte 5、Sveltia CMS、Tailwind CSS 3、TypeScript 和 Biome。
  • 内容入口:src/content/posts/ 中的 Markdown 文章。
  • 站点配置:src/config.ts
  • 路由入口:src/pages/
  • 生产构建:pnpm build 先运行 astro build,再使用 Pagefind 为 dist/ 生成搜索索引。
  • 包管理器:仓库声明的版本为 pnpm@9.14.4,依赖通过 pnpm-lock.yaml 锁定。

文档维护约定

  • 新增开发文档使用数字前缀,并在本文件中登记链接。
  • 命令、路径和配置项以当前 package.json、源码和 CI 配置为准;发现冲突时先修正文档,再修改示例。
  • 文档中的路径均以仓库根目录为基准;文档之间的链接使用相对路径。
  • 修改脚本、目录或发布流程后,至少重新检查受影响文档中的命令和路径。