Alnair

Plume

一个轻量、快速、优雅的静态博客生成器。

English 中文

特性

安装

npm install

快速开始与自定义

🎨 想要自定义你的博客? 查看 CONFIG.md 了解详细的配置选项。

🚀 想要部署到 GitHub Pages? 查看 DEPLOY.md 获取详细步骤。

你可以轻松自定义:

使用方法

  1. posts/ 目录下创建 Markdown 文件
  2. 运行构建命令生成 HTML
npm run build

生成的 HTML 文件将输出到 public/ 目录。

文章格式

每篇文章需要在顶部包含 YAML front matter:

---
title: 文章标题
date: 2025-10-27
modified: 2025-10-27  # 可选:最后修改时间
tags: [标签1, 标签2]  # 可选:文章标签
math: true            # 可选:启用数学公式
archived: true        # 可选:归档文章(不在首页显示)
---

## 这是标题

文章内容从这里开始...

Front Matter 字段说明

功能特性

📐 数学公式

在 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          # 说明文档

设计理念

这个博客遵循简洁的理念:

  1. 保持简单 - 没有不必要的复杂性
  2. 保持快速 - 最少的资源,快速加载
  3. 保持无障碍 - 所有人都能阅读
  4. 保持可读 - 良好的排版和间距
  5. 保持整洁 - 整洁的代码和设计

开发

# 构建一次
npm run build

# 监视模式(如果实现了)
npm run watch

许可证

MIT - 随意使用!