Shirone 写作与使用指南

本指南将带你了解文章创建、frontmatter 规范、目录结构，以及内置的全套 Markdown 与 MDX 扩展能力。

站点本身用 Astro 构建 —— 静态输出、零客户端 JavaScript 注水，构建流程细节见 Vite 相关笔记。

欢迎使用 Shirone（白音）——一款围绕 Astro 7、Svelte 5 与 Material 3 Expressive（M3E） 设计体系打造的表现力强、二次元气质的博客主题。

本指南将带你了解文章创建、frontmatter 规范、目录结构，以及内置的全套 Markdown 与 MDX 扩展能力。

1. 创建新文章#

你可以使用内置的 CLI 命令快速生成一篇带有标准 frontmatter 的新文章：

1
# 创建单文件文章
2
pnpm new-post my-first-post
3

4
# 或在子目录中创建文章
5
pnpm new-post guides/getting-started

新创建的文件会被放入 src/content/posts/。

2. Frontmatter 规范#

每篇 Markdown（.md）或 MDX（.mdx）文章都以一段 YAML frontmatter 开头，用于定义其元数据。

示例#

1
---
2
title: "Exploring Material 3 Expressive Design"
3
published: 2026-08-26
4
updated: 2026-08-27
5
publishedAt: 2026-08-26T10:00:00+08:00
6
updatedAt: 2026-08-27T09:30:00+08:00
7
pinned: true
8
description: "A deep dive into dynamic HCT color science and fluid transitions in Shirone."
9
image: "./cover.webp"
10
tags: [M3E, Design, Frontend]
11
category: Guides
12
draft: false
13
comment: true
14
---

支持的 Frontmatter 字段#

字段	类型	必填	说明
`title`	`string`	是	文章主标题。
`published`	`Date`	是	发布日期，格式为 `YYYY-MM-DD`。
`publishedAt`	`Date`	否	精确的发布时刻，用于为同日发布的文章排序。它必须落在 `published` 当天（按站点配置的时区计算）。
`updated`	`Date`	否	最后更新日期。填写后会显示更新提示徽标。
`updatedAt`	`Date`	否	精确的更新时刻，供订阅源与机器可读元数据使用。必须与 `updated` 搭配填写。
`pinned`	`boolean`	否	将文章置顶到文章列表（默认：`false`）。
`description`	`string`	否	文章摘要，显示在文章卡片、搜索结果与 OpenGraph 元数据中。
`image`	`string`	否	封面图路径。支持相对路径（`./cover.webp`）、public 路径（`/images/cover.jpg`）或远程 URL。
`tags`	`string[]`	否	标签名数组，用于分类法筛选与标签云。
`category`	`string`	否	主分类名称，用于分类法索引。
`draft`	`boolean`	否	标记为草稿。草稿在生产构建（`pnpm build`）时会被隐藏。
`comment`	`boolean`	否	单独控制该文章的评论区开关（默认：`true`）。
`lang`	`string`	否	语言代码（如 `en`、`zh_CN`、`ja`），当与站点默认语言不同时使用。

3. 文章加密#

Shirone 提供客户端文章加密。这是一个静态的密码门禁，而非服务端访问控制：加密后的正文载荷与资源 URL 仍可被公开下载，因此请勿将它用于真正机密的文件或受监管的敏感信息。对于私密日记或限定访问的文章，可在 frontmatter 中指定密码：

1
---
2
title: "Private Research Notes"
3
published: 2026-08-26
4
encrypted: true
5
password: "your-secret-passphrase"
6
passwordHint: "Favorite anime character"
7
hideHomeContent: true
8
---

encrypted：设为 true 即可启用加密；
password：解锁文章所需的密码字符串或数字；
passwordHint：可选的密码提示，显示在密码输入表单上方；
hideHomeContent：隐藏首页的字数与内容预览，防止信息泄露。

4. 组织文章文件#

Shirone 同时支持文件夹共置与单文件两种布局：

文件夹结构（推荐用于本地资源）#

把文章与其媒体文件放在一起，资源管理会非常直接：

1
src/content/posts/
2
├── my-great-post/
3
│   ├── index.md           <-- 文章内容
4
│   ├── cover.webp         <-- 封面图（image: "./cover.webp"）
5
│   └── diagram.png        <-- Markdown 中引用的内文插图

单文件结构（轻量随笔）#

1
src/content/posts/
2
├── hello-world.md
3
└── quick-thoughts.md

5. 丰富的 Markdown 与 MDX 扩展#

Shirone 开箱即带现代 Markdown 扩展能力：

5.1 提示块#

使用容器指令书写提示、要点、警告与警示：

1
:::tip
2
使用提示块容器突出关键结论或最佳实践。
3
:::
4

5
:::warning
6
使用警告容器提示潜在陷阱或不兼容变更。
7
:::

5.2 GitHub 仓库卡片#

使用指令语法嵌入实时且样式精致的 GitHub 仓库卡片：

1
::github{repo="LyraVoid/Shirone"}

LyraVoidShirone

5.3 Expressive Code 代码块#

增强代码块具备语法高亮、文件名徽标、行号以及按行高亮能力：

1
// 基于 HCT 的动态颜色令牌推导
2
import { argbFromHex, themeFromSourceColor } from "@material/material-color-utilities";
3

4
const theme = themeFromSourceColor(argbFromHex("#f472b6"));
5
console.log("Primary color token:", theme.schemes.light.primary);

5.4 数学排版（KaTeX）#

直接在 Markdown 中渲染优雅的 LaTeX 数学记号：

行内公式： $E = mc^2$ ，或欧拉公式 $e^{i\pi} + 1 = 0$ 。
块级公式：

\int_{-\infty}^{\infty} e^{-x^2} \, dx = \sqrt{\pi}

5.5 Mermaid 图表#

用纯文本创建流程图、时序图与架构图：

sequenceDiagram
    autonumber
    actor Visitor as 访客
    participant Page as Shirone 页面
    participant Swup as Swup 容器
    participant Audio as 常驻框架

    Visitor->>Page: 点击导航链接
    Page->>Swup: 触发无缝过渡
    Swup->>Page: 替换 #swup-container
    Note over Audio: 背景音乐持续播放
    Page-->>Visitor: 新页面完成渲染

5.6 图片画廊与 Fancybox 灯箱#

图片会自动接入 Fancybox，支持无损缩放、拖拽手势与全屏预览：

1
![Cover preview](./cover.jpeg)

6. 后续步骤与自定义#

站点配置：在 src/config/siteConfig.ts 与 src/config/README.md 中了解全局设置。
设计令牌：在 DESIGN.md 与 docs/m3e-standard.md 中探索设计令牌与配色方案。
反馈与社区：在 GitHub Issues 分享你的想法与疑问。

蓝色大肥鱼

1. 创建新文章#

2. Frontmatter 规范#

示例#

支持的 Frontmatter 字段#

3. 文章加密#

4. 组织文章文件#

文件夹结构（推荐用于本地资源）#

单文件结构（轻量随笔）#

5. 丰富的 Markdown 与 MDX 扩展#

5.1 提示块#

5.2 GitHub 仓库卡片#

5.3 Expressive Code 代码块#

5.4 数学排版（KaTeX）#

5.5 Mermaid 图表#

5.6 图片画廊与 Fancybox 灯箱#

6. 后续步骤与自定义#

继续阅读

换条路线

评论

蓝色大肥鱼

1. 创建新文章#

2. Frontmatter 规范#

示例#

支持的 Frontmatter 字段#

3. 文章加密#

4. 组织文章文件#

文件夹结构（推荐用于本地资源）#

单文件结构（轻量随笔）#

5. 丰富的 Markdown 与 MDX 扩展#

5.1 提示块#

5.2 GitHub 仓库卡片#

5.3 Expressive Code 代码块#

5.4 数学排版（KaTeX）#

5.5 Mermaid 图表#

5.6 图片画廊与 Fancybox 灯箱#

6. 后续步骤与自定义#

分享文章

沿着主题读

换条路线