Skip to content

Latest commit

 

History

History
100 lines (66 loc) · 3.01 KB

File metadata and controls

100 lines (66 loc) · 3.01 KB

参与贡献

如何撰写博客

PFCC blog 采用了 VitePress 作为静态网站生成工具,以提供最佳的博客撰写体验,你可以基本上实时地从网页上看到自己的的修改效果。

为了获得最佳的开发体验,希望你能跟随我进行一些简单的设置。

编辑器集成optional

我们推荐你使用 VS Code 作为编辑器,它可以提供本博客最佳的开发体验。

之后在项目根目录创建 .vscode/settings.json,并添加以下配置项:

{
   "[html][markdown][javascript][typescript][vue][jsonc][json]": {
      "editor.defaultFormatter": "esbenp.prettier-vscode",
   },
   "editor.formatOnSave": true,
}

并安装 Prettier 扩展以实现自动代码格式化。

本地开发

本 blog 基于 Node.js 生态,因此需要你事先安装 Node.js 18+,并安装 pnpm 作为包管理器。

如果你使用的是 macOS + Homebrew,可以使用如下命令安装:

brew install node corepack # 安装 Node.js 和 corepack
corepack enable            # 启用 corepack,corepack 会自动根据 package.json 中的 packageManager 字段来安装合适版本的 pnpm

之后只需要运行如下命令安装所有依赖项:

pnpm i

安装完成后,运行如下命令启动本地开发服务器:

pnpm dev

此时可按照提示打开相应的网址(默认为 http://localhost:5173/)查看预览效果啦~

博客开发规范

博客文件

博客文件统一放置在 src/posts 目录下,每篇博客对应一个 .md 文件,文件名即为博客的 URL。

文件名统一使用 kebab-case,如 hello-world.md

  1. 博客置顶

    若有置顶某篇博客的需求,需要确保该博客文章在 frontmatter 中包含 pinned: true 字段。例如:

    ---
    title: 2024 年飞桨开源社区年度报告
    date: 2025-02-07
    ...
    pinned: true
    ---
    
    文章内容...
    
  2. 博客分类

    需要确保每篇博客文章在 frontmatter 中包含 category 字段,以便实现博客的分类展示。例如:

    ---
    title: 文章标题
    date: 2025-04-01
    category: community-activity
    ---
    
    文章内容...
    
    category 字段 含义
    community-activity 飞桨开源社区动态、活动进展
    developer-story 飞桨社区开发者访谈、开发者故事
    insights 前沿洞察、技术分享

图片文件

图片文件统一放置在 src/images 目录下,每篇博客对应一个子目录,子目录名即为博客的文件名,比如 hello-world.md 对应的图片目录为 src/images/hello-world

博客主题开发指南

TODO...