Bogl Blog

轻量静态博客生成器，专为 Tencent EdgeOne Pages 优化。

特性

• 纯静态输出：无服务端依赖，部署简单
• 自动编码转换：GBK / GB2312 自动识别并转为 UTF-8
• 换行规范化：CRLF 自动转为 LF
• Markdown 支持：YAML Frontmatter + 标准 Markdown 语法
• Mermaid 图表：支持 mermaid 代码块渲染流程图等
• 多页面生成：首页、文章页、标签页、归档页、RSS
• 文章目录：自动生成 TOC 侧边栏导航
• 主题系统：基于 Nunjucks 模板引擎，易于定制

目录结构

.
├── build.js              # 构建入口
├── edgeone.json          # EdgeOne Pages 配置
├── package.json          # 项目依赖
├── lib/                  # 核心构建模块
│   ├── content.js        # 内容拉取与 Markdown 解析
│   ├── renderer.js       # Nunjucks 模板渲染
│   ├── generators.js     # 页面生成器
│   └── utils.js          # 工具函数
├── src/
│   ├── templates/        # Nunjucks 模板
│   │   ├── base.html
│   │   ├── index.html
│   │   ├── post.html
│   │   ├── tag.html
│   │   ├── tags.html
│   │   └── archive.html
│   └── assets/
│       ├── css/style.css
│       ├── js/main.js
│       └── vendor/mermaid.min.js
├── content/
│   └── posts/            # Markdown 文章存放处
└── dist/                 # 构建输出（部署目录）

快速开始

安装依赖

npm install

本地开发

npm run build        # 构建到 dist/
npm run dev          # 监听模式，文件变更自动重建
npm run clean        # 清理 dist/

本地预览：

cd dist && python -m http.server 8080

访问 http://localhost:8080

写作

在 content/posts/ 目录下新建 .md 文件：

---
title: 文章标题
date: 2026-04-08
tags: [标签1, 标签2]
---

正文内容，支持 Markdown 语法。

Frontmatter 字段

字段	必填	说明
title	是	文章标题
date	否	发布日期，默认文件修改时间
tags	否	标签数组
draft	否	设为 true 则不发布

部署到 EdgeOne Pages

方式一：Git 部署（推荐）

1. Fork/Clone 本项目到 GitHub 私有仓库
2. 在 EdgeOne Pages 控制台 创建项目
3. 选择 GitHub 仓库，授权访问
4. 配置自动构建：
   • 构建命令：npm run build
   • 输出目录：dist
5. 保存并部署

后续每次 git push 都会自动触发重新构建和部署。

方式二：CLI 部署

npx edgeone pages deploy

自定义配置

所有个性化配置均通过环境变量提供，不再硬编码在源码中，方便 fork 后零修改直接使用。

环境变量列表

环境变量	说明	示例值
SITE_URL	站点域名（带 https://）	https://your-domain.com
SITE_ICP	ICP 备案号（空则页脚不显示）	京ICP备12345678号-1
SITE_PSB	公安备案号（空则不显示）	京公网安备11010502012345号
ADSENSE_ID	Google AdSense 发布者 ID（纯数字，可带 ca-pub- 前缀）	1234567890123456
GITHUB_URL	GitHub 仓库链接（导航栏图标）	https://github.com/yourname/blog
AUTHOR_NAME	文章作者名称（JSON-LD 用）	yourname
GISCUS_REPO	Giscus 评论仓库	yourname/blog
GISCUS_REPO_ID	Giscus 仓库 ID	R_xxxxxxxxxx
GISCUS_CATEGORY	Giscus 分类名称	Announcements
GISCUS_CATEGORY_ID	Giscus 分类 ID	DIC_xxxxxxxxxx

未设置的环境变量对应功能将静默跳过，不会输出任何个人标识。

本地使用 .env

项目根目录创建 .env 文件：

SITE_URL=https://your-domain.com
SITE_ICP=京ICP备12345678号-1
ADSENSE_ID=1234567890123456
GITHUB_URL=https://github.com/yourname/blog
AUTHOR_NAME=yourname

本地构建前导出环境变量即可：

export $(cat .env | xargs)
npm run build

.env 文件已被 .gitignore 忽略，不会误提交到仓库。

EdgeOne Pages 环境变量配置

在 EdgeOne Pages 控制台 → 项目设置 → 环境变量 中添加。

支持批量导入：将 .env 文件全部内容粘贴到变量名输入框即可自动解析。

主题样式

修改 src/assets/css/style.css 即可自定义主题。

模板文件位于 src/templates/，使用 Nunjucks 语法。

缓存与安全

edgeone.json 中已预配置：

• 静态资源长期缓存：/assets/*（max-age=31536000, immutable）
• 安全响应头：X-Frame-Options: DENY、X-Content-Type-Options: nosniff
• 边缘缓存策略：文章页 1 天，RSS 0 秒

如需更新 CSS/JS 并强制浏览器刷新，修改模板中引用路径的版本号：

<link rel="stylesheet" href="assets/css/style.css?v=6" />

内容分离部署（可选）

如果希望文章仓库与生成器仓库分离，可额外设置：

环境变量	说明
CONTENT_REPO	内容仓库，如 owner/posts-repo
CONTENT_BRANCH	内容分支，默认 main
GITHUB_TOKEN	GitHub 访问令牌（私有仓库必填）

限制说明

• EdgeOne Pages 为 Clean Build 环境，每次构建都是全新的，不支持增量构建
• 单项目文件数上限：20,000
• 单文件大小上限：25 MB
• 账户总存储上限：5 GB

License

• 代码（build.js、lib/、模板、样式、脚本等）：MIT License
• 文章/内容（content/ 目录下）：采用 CC BY 4.0 许可，转载需署名并附上原作者 GitHub 链接（https://github.com/yang12535）

第三方许可证

• jschardet@3.1.4：LGPL-2.1+