一个轻量、快速、优雅的静态博客生成器。
| English | 中文 |
npm install
🎨 想要自定义你的博客? 查看 CONFIG.md 了解详细的配置选项。
🚀 想要部署到 GitHub Pages? 查看 DEPLOY.md 获取详细步骤。
你可以轻松自定义:
posts/ 目录下创建 Markdown 文件npm run build
生成的 HTML 文件将输出到 public/ 目录。
每篇文章需要在顶部包含 YAML front matter:
---
title: 文章标题
date: 2025-10-27
modified: 2025-10-27 # 可选:最后修改时间
tags: [标签1, 标签2] # 可选:文章标签
math: true # 可选:启用数学公式
archived: true # 可选:归档文章(不在首页显示)
---
## 这是标题
文章内容从这里开始...
title (必需): 文章标题date (必需): 发布日期 (YYYY-MM-DD 格式)modified (可选): 最后修改日期tags (可选): 文章标签数组math (可选): 设为 true 启用 MathJax 数学公式渲染archived (可选): 设为 true 将文章归档(不在首页显示,但仍可访问)在 front matter 中设置 math: true 启用数学公式:
行内公式:$E = mc^2$
块级公式:
$$
\int_{-\infty}^{\infty} e^{-x^2} dx = \sqrt{\pi}
$$
在 front matter 中添加标签:
tags: [JavaScript, Tutorial, Web Development]
系统会自动生成:
要归档某篇文章(不在首页显示但保持可访问):
archived: true
归档的文章会:
系统自动为每篇文章生成目录,包含:
构建时会自动删除:
blog/
├── posts/ # Markdown 文章
│ ├── welcome.md
│ └── ...
├── public/ # 生成的 HTML(自动生成)
│ ├── index.html
│ ├── tags.html
│ ├── archive.html
│ └── ...
├── template.html # HTML 模板
├── build.js # 构建脚本
├── package.json # 项目配置
└── README.md # 说明文档
这个博客遵循简洁的理念:
# 构建一次
npm run build
# 监视模式(如果实现了)
npm run watch
MIT - 随意使用!