默认播放器（带标题、作者、循环按钮、音量控制）：

无封面、无作者的简洁播放器：

卡片组件

简单卡片：

墓碑卡片 + 计数器

带内容的卡片

按钮组件

图片加载

正常图片（会显示骨架加载动画）：

加载失败的图片（会显示破碎图片图标）：

组件语法参考

音乐播放器

<!--PAPER_COMPONENT_12-->

所有参数除 src 外均可选。

卡片

<!--PAPER_COMPONENT_13-->
可选的卡片内容（如按钮、计数器等）
<!--PAPER_COMPONENT_14-->

计数器按钮

<!--PAPER_COMPONENT_15-->

按钮

<!--PAPER_COMPONENT_16-->

精神科诊断卡

<!--PAPER_COMPONENT_18-->

墓碑

<!--PAPER_COMPONENT_21-->

添加 incense="true" 开启上香按钮。点击后会插三炷香，带烟雾效果，越烧越短，最后烧完。上香次数通过 localStorage 持久化。

遗书

<!--PAPER_COMPONENT_24-->
遗书正文，支持 HTML。
<!--PAPER_COMPONENT_25-->

Paper 是一个零依赖（几乎）的静态博客生成器。用 Markdown 写文章，一条命令构建，直接部署到 GitHub Pages。

特性一览：

• 📝 Markdown 写作 + YAML frontmatter
• 🎨 纸质暖色调 + 深色模式自适应
• 🔍 客户端全文搜索（Ctrl+K）
• 📑 自动生成目录（TOC）
• 🏷️ 标签系统 + 归档页
• 💬 评论系统（utterances）
• 📡 RSS + Atom 订阅
• 🗺️ 自动 Sitemap + robots.txt
• ⚡ 代码高亮（Prism.js）
• 📖 阅读时间估算
• 📄 分页
• 🚀 GitHub Actions 一键部署

快速开始

# 克隆
git clone https://github.com/Linbo-cyber/paper.git my-blog
cd my-blog

# 安装依赖
npm install

# 写文章
# 在 posts/ 目录下创建 .md 文件

# 构建
npm run build

# 输出在 dist/ 目录

文章格式

在 posts/ 目录下创建 .md 文件，文件名即为 URL slug：

---
title: 我的第一篇文章
date: 2026-01-01
tags: [随笔, 技术]
description: 这是文章摘要
lang: zh-CN
draft: false
---

正文内容，支持完整的 Markdown 语法。

Frontmatter 字段

代码高亮

支持所有主流语言：

function hello(name) {
  console.log(`Hello, ${name}!`);
  return { greeting: true };
}

def fibonacci(n):
    a, b = 0, 1
    for _ in range(n):
        yield a
        a, b = b, a + b

自定义页面

在 pages/ 目录下创建 .md 文件，会生成为根路径下的独立页面。比如 pages/about.md → /about.html。

主题

默认主题在 themes/default/ 下。你可以：

• 修改 assets/style.css 调整样式
• 修改 templates/ 下的 HTML 模板
• 创建新主题目录，在 paper.config.js 中切换

部署

推送到 GitHub，Actions 会自动构建并部署到 Pages。就这么简单。

支持 :::note :::tip :::warning :::caution :::important 五种样式：

也支持 GitHub 风格的语法：

代码复制按钮

鼠标悬停在代码块上，右上角会出现复制按钮：

function greet(name) {
  console.log(`Hello, ${name}!`);
  return { success: true };
}

greet('Paper');

# 克隆 Paper
git clone https://github.com/Linbo-cyber/paper.git
cd paper && npm install && npm run build

封面图

这篇文章设置了 cover 字段，标题下方会显示封面大图。

在 frontmatter 中添加：

cover: https://example.com/image.jpg

主题切换

点击导航栏右侧的太阳/月亮图标，可以手动切换深色/浅色模式。选择会保存到 localStorage。

阅读进度条

页面顶部有一条细线，随滚动显示阅读进度。

回到顶部

滚动超过一定距离后，右下角会出现回到顶部按钮。

相关文章

文章底部会根据标签匹配推荐相关文章。

这是一段普通文本。粗体、斜体、删除线、行内代码。

这是一个链接

引用

好的工具应该像空气一样——你不会注意到它，但离开它你会窒息。

嵌套引用：

第二层引用

列表

无序列表：

• 第一项
• 第二项
  • 嵌套项
  • 另一个嵌套项
• 第三项

有序列表：

1. 步骤一
2. 步骤二
3. 步骤三

代码

行内代码：const x = 42;

代码块：

package main

import "fmt"

func main() {
    ch := make(chan string, 1)
    go func() {
        ch <- "hello from goroutine"
    }()
    fmt.Println(<-ch)
}

fn main() {
    let numbers: Vec<i32> = (1..=10)
        .filter(|x| x % 2 == 0)
        .collect();
    println!("{:?}", numbers);
}

表格

图片

图片语法：![alt](url)

分割线

任务列表

• 完成基础框架
• 添加代码高亮
• 添加搜索功能
• 添加更多主题

数学公式

Paper 目前不内置数学公式支持，但你可以通过在模板中引入 KaTeX 来实现。

脚注

这是一段带脚注的文本^1。