VitePress博客

vitepress-teek-blog — VitePress 博客模板

作者 sunyzhi55

基于 VitePress 与 vitepress-theme-teek 的纯静态博客/知识库模板,含本地定制主题、独立页面与资源维护脚本。

看看你的网站会是什么样

浏览真实页面截图,比较内容排版与手机效果。点击下方缩略图切换,放大查看整页细节。

2 个预览视图
桌面端首页1 / 2
桌面端截图首屏预览

由服务器浏览器实际访问页面后截取。

全部页面与视图 2

截图用于了解视觉与布局,交互效果请以实际项目为准。

采集于 2026-10-01查看来源

值得关注的模板亮点

从已有项目资料中,快速了解它的特点。

01

基于 VitePress 与 vitepress-theme-teek 主题构建的纯静态博客/知识库

02

在主题基础上做本地定制,README 提到侧边栏与首页布局等改动

03

docs/@pages/ 提供归档、标签、分类、订阅等独立页面

04

支持多款字体,字体文件放在 docs/public/font/ 并通过 font.scss 引入

05

附带 permalink 批量处理与未引用静态资源扫描两个维护脚本

模板详细介绍

这是一个纯静态博客/知识库项目,构建在 VitePress 之上,并使用 vitepress-theme-teek 主题。仓库在主题基础上做了本地定制,README 提到侧边栏、首页布局等改动,并记录了 2026-02-20 与 2026-08-06 两次修改:前者新增“杂想集”专题并在侧边栏和导航栏加入口,同时增加多款字体支持;后者说明重新 clone 项目后继续修改。

内容组织上,站点内容与配置集中在 docs/ 目录:.vitepress/ 存放 VitePress 配置与本地主题增强,@pages/ 放归档、标签、分类、订阅等独立页面,nav/ 放导航页,public/ 放图片、字体、图标等静态资源。文章以 Markdown 形式直接放在 docs/ 下,图片等资源建议放入 docs/public/ 并用绝对路径引用。

项目使用 pnpm 管理依赖,提供 docs:dev、docs:build、docs:preview、format 等脚本,构建产物输出到 docs/.vitepress/dist/,该目录已在 .gitignore 中忽略。仓库还包含两个可选维护脚本:scripts/python/md_permalink_processor.py 用于批量处理 Markdown 的 permalink,scripts/node/find-unused-public-assets.mjs 用于扫描 docs/public/ 下未被源码引用的静态资源,并支持 --delete 删除。

部署方面,README 将其定位为纯静态站点,推荐 GitHub Pages 或任意静态托管平台,可本地构建后发布 dist 目录,或使用 GitHub Actions 自动构建发布。仓库采用 MIT 许可,但演示图片、字体、图标等第三方素材需按各自许可核对。

VitePress博客

适合你的项目吗?

适用场景

  • 搭建个人博客并发布 Markdown 文章
  • 整理技术笔记或知识库并配置导航与侧边栏
  • 需要归档、标签、分类、订阅等独立页面的静态站点
  • 部署到 GitHub Pages 或其他静态托管平台

适合人群

  • 熟悉 Markdown 写作、希望用 VitePress 搭建博客的个人开发者
  • 需要纯静态输出、不依赖服务端渲染的站点维护者
  • 愿意按自身需求调整主题配置与页面布局的使用者

上手与定制指南

结合仓库当前版本的说明,按下面的资料检查内容、配置与运行要求。

  1. 1

    环境要求 Node.js(README 建议 18+)并使用 pnpm 管理依赖

  2. 2

    安装依赖执行 pnpm install,本地开发执行 pnpm docs:dev

  3. 3

    构建执行 pnpm docs:build,产物输出到 docs/.vitepress/dist/,该目录已被 .gitignore 忽略

  4. 4

    本地预览构建结果执行 pnpm docs:preview,格式化代码执行 pnpm format

  5. 5

    新文章直接在 docs/ 下新建 .md 文件,图片等资源放入 docs/public/ 并用绝对路径引用

查看仓库使用说明

授权与来源资料

使用条件与限制

免费使用 · 保留许可声明

本次收录的是公开仓库中采用 MIT 许可的免费版本;免费范围为该版本代码,不代表外部服务或第三方素材免费。

使用时需要遵守

  • 允许免费使用、修改、商用和分发该版本代码。
  • 分发代码副本或实质性部分时,保留原作者版权声明和完整 MIT 许可声明。
  • 代码按现状提供;担保与责任限制以原许可证及适用法律为准。

额外费用与待核对事项

  • 项目依赖第三方主题 vitepress-theme-teek,使用与再分发该主题需遵守其自身许可;本地定制部分才适用本仓库的 MIT 许可。
  • 仓库内置的抖音美好体等字体为第三方素材,其许可与代码的 MIT 许可不同,商用或再分发前须自行核实字体授权。
  • 霞鹜系列字体虽为开源,但适用其自身字体许可(如 OFL),并非本仓库 MIT 许可,再分发时需保留相应许可声明。
  • 部署到 GitHub Pages 需使用 GitHub 账号与仓库,属于外部服务;README 未承诺任何托管或可用性保证。
  • 演示图片、字体、图标及其他第三方素材需按各自许可核对,不能仅凭代码的 MIT 许可判断。
  • 域名、托管、数据库、支付或 AI 等外部服务可能另外收费。
查看原文依据

Permission is hereby granted, free of charge

许可证原文

使用 `vitepress-theme-teek` 主题,并做了一些本地定制化修改(如侧边栏、首页布局等)。

README 原文

docs\public\font\DouyinSansBold.otf ---> 抖音美好体(加粗)

README 原文

霞鹜系列开源字体:https://github.com/lxgw/LxgwWenKai

README 原文

将生成的 `docs/.vitepress/dist/` 发布到 Pages(或用 GitHub Actions 自动构建发布)

README 原文
https://github.com/sunyzhi55/vitepress-teek-blog/blob/main/LICENSEhttps://github.com/sunyzhi55/vitepress-teek-blog/blob/main/README.md

DeepSeek 根据仓库许可证和 README 整理 ·2026-10-01。结果仅覆盖已读取资料,依赖、图片、字体及后续条款变更以各自原文为准。

项目核对记录与介绍依据

模板资料

来源平台
GitHub
资料与维护参考分
资料较完整 · 83 / 100
技术栈
VitePress
网站类型
博客
这个分数如何计算

本站按许可资料(最高30分)、演示链接(12分)、预览图(10分)、Star数(15分)、记录的维护时间(15分)、描述完整度(8分)、功能记录(5分)和分类资料(5分)计算。它不是代码、安全或性能测试,也不是 Google 评分;有链接不代表已实测可用。

这个项目需要核对什么

记录的仓库更新时间
2026-08-29
截图检查日期
2026-10-01

已收录演示链接。请用你的内容与屏幕尺寸检查;有演示不代表表单、认证或支付已经可用。

目录记录的主要技术栈是 VitePress。请通过依赖清单和锁文件核对实际版本与托管要求。这些说明基于收录资料,不代表代码审计或部署实测。

查看具体选型方法 →

介绍的制作与核对状态

介绍由 AI 辅助整理目录与仓库资料。仓库作者不等于这篇介绍的审核者。

已完成服务器许可规则与 AI 来源核对;未经过人工编辑审核。

查看当时使用的来源资料

SHA-256: 2fe8ffd265e14a9a4d98c26ad193ec16cb895794a469a9bb38a8db599d88dd96

2026-10-01T03:55:45.712Z

来源文件 / 仓库
# 🔥Flumina Blog(VitePress)

<div align="center" style="display: flex; justify-content: center;">
  <img src="./assets/gemini-frame.png" width="85%" alt="gemini-Flumina" />
</div>

<br />

<div align="center" style="display: flex; justify-content: center;">
  <img src="./assets/gpt-frame.png" width="85%" alt="gpt-VitePress" />
</div>

---

这是一个基于 **VitePress** + **vitepress-theme-teek** 的纯静态博客/知识库项目。

参考链接:

- [VitePress 官方文档](https://vitepress.dev/)
- [vitepress-theme-teek 主题仓库](https://github.com/Kele-Bingtang/vitepress-theme-teek)
- [teek-hyde 主题仓库(Gitee)](https://gitee.com/SeasirHyde/teek-hyde)


## 记录修改地方


### 2026-08-06

上游情况 [teek-hyde 主题仓库(Gitee)](https://gitee.com/SeasirHyde/teek-hyde):

```
chore(deps): 升级 vitepress-theme-teek 至 1.6.2
Seasir Hyde Seasir Hyde 提交于 7月31日 19:32 222次提交
```

重新clone项目进行了修改。


- 使用 `vitepress-theme-teek` 主题,并做了一些本地定制化修改(如侧边栏、首页布局等)。




### 2026-02-20 22:38:00

1、添加文章,增加专题 `杂想集`,并在侧边栏和导航栏增加入口链接。

2、增加多个字体支持。

参考链接:https://teek.seasir.top/Teek/9c027f

路径:
`docs\.vitepress\theme\styles\font.scss`,并将字体文件放在 `docs\public\font\` 目录下.

说明:

```
docs\public\font\DouyinSansBold.otf ---> 抖音美好体(加粗)
docs\public\font\Hangyitangmeiren.woff2 ---> 汉仪唐美人体

霞鹜系列开源字体:https://github.com/lxgw/LxgwWenKai

docs\public\font\LXGWWenKaiMonoGBLite-Medium.woff2 ---> 霞鹜系列开源字体
docs\public\font\LXGWWenKaiMonoGBLite-Regular.woff2 ---> 思霞鹜系列开源字体
docs\public\font\TsukuARdGothicStd-Bold.woff2 ---> 筑紫A丸ゴシック(加粗)
```




## 快速开始

### 环境要求

- Node.js(建议 18+,越新越好)
- pnpm(本项目使用 pnpm 管理依赖)

### 安装依赖

```bash
pnpm install
```

### 本地开发

```bash
pnpm docs:dev
```

启动后根据终端输出打开本地地址即可预览。

### 构建产物

```bash
pnpm docs:build
```

构建输出会生成到 `docs/.vitepress/dist/`(该目录已在 `.gitignore` 中忽略,不建议提交)。

### 本地预览构建结果

```bash
pnpm docs:preview
```

### 格式化重要代码文件

```bash
pnpm format
```

## 目录结构(精简后)

```text
.
├─ docs/                      # 站点内容(Markdown)与 VitePress 配置
│  ├─ .vitepress/              # VitePress 配置与本地主题增强
│  ├─ @pages/                  # 独立页面(归档/标签/分类/订阅等)
│  ├─ nav/                     # 导航页(含导航组件渲染)
│  ├─ public/                  # 静态资源(图片/字体/图标等,最终会原样拷贝到站点根目录)
│  └─ ...                      # 你的文章/笔记内容
├─ scripts/
│  └─ python/                  # 一些维护脚本(可选)
├─ package.json                # 脚本与依赖
└─ pnpm-lock.yaml              # 锁文件(建议提交)
```

## 写作与资源建议

- 新文章:直接在 `docs/` 下新建 `.md` 文件即可。
- 图片/资源:建议放到 `docs/public/` 下,再用 `/xxx/yyy.png` 这种绝对路径引用。
  - 例如:`docs/public/images/a.png` → Markdown 中写 `![](/images/a.png)`

## 部署(GitHub Pages)

这是纯静态站点,推荐用 GitHub Pages 或任意静态托管平台部署。

常见做法:

1. 本地执行 `pnpm docs:build`
2. 将生成的 `docs/.vitepress/dist/` 发布到 Pages(或用 GitHub Actions 自动构建发布)

如果你需要我帮你补一个 GitHub Actions(自动构建并部署到 Pages),告诉我你的仓库名和 Pages 目标分支(通常是 `gh-pages`)。

## 可选脚本

### 批量处理 Markdown 的 permalink

脚本位置:`scripts/python/md_permalink_processor.py`

示例:

### 扫描未引用的 public 静态资源

脚本位置:`scripts/node/find-unused-public-assets.mjs`

用途:扫描 `docs/public/` 下的图片/字体/图标等资源,找出在源码中没有被引用的文件,帮助你做第二轮精简。

```bash
node scripts/node/find-unused-public-assets.mjs
```

确认列表无误后,可加 `--delete` 自动删除:

```bash
node scripts/node/find-unused-public-assets.mjs --delete
```

```bash
# 预览会处理哪些文件(不写入)
python scripts/python/md_permalink_processor.py --dry-run

# 将 docs/ 下所有 md 的 permalink 更新为 /note/xxx
python scripts/python/md_permalink_processor.py -d "./docs" -p "note"
```

## 常用命令

```bash
# 开发
pnpm docs:dev
# 构建
pnpm docs:build
# 预览
pnpm docs:preview
# 格式化重要代码文件
pnpm format
```

反馈内容错误

看看同类模板

对比同技术栈与用途的模板,找到更适合的视觉与内容结构。