Shirone 写作与使用指南 - Shirone × Znfooe

欢迎来到 Shirone（白音）——一个以 Astro 7、Svelte 5 与 Material 3 Expressive（M3E） 设计体系打造、富有表现力的动漫风格博客主题。

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

1. 创建新文章#

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

1
# Create a single-file post
2
pnpm new-post my-first-post
3

4
# Or create a post in a sub-directory
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 提供客户端文章加密。对于私人日志或受限文章，可在 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           <-- Post content
4
│   ├── cover.webp         <-- Cover image (image: "./cover.webp")
5
│   └── diagram.png        <-- Inline illustration referenced in markdown

单文件结构（轻量短文）#

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

5. 丰富的 Markdown 与 MDX 扩展#

Shirone 开箱即用地集成了现代化 Markdown 扩展：

5.1 Admonition 提示框#

使用容器指令来书写注释、提示、警告与提醒：

1
:::tip
2
Use admonition containers to highlight key takeaways or best practices.
3
:::
4

5
:::warning
6
Use warning containers to signal potential pitfalls or breaking changes.
7
:::

5.2 GitHub 仓库卡片#

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

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

LyraVoidShirone

5.3 Expressive Code 代码块#

增强型代码块支持语法高亮、文件名徽标、行号与选择性高亮指定行：

1
// Dynamic HCT color token derivation
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 Visitor
    participant Page as Shirone Page
    participant Swup as Swup Container
    participant Audio as Persistent Shell

    Visitor->>Page: Click Navigation Link
    Page->>Swup: Trigger Seamless Transition
    Swup->>Page: Replace #swup-container
    Note over Audio: Background music plays continuously
    Page-->>Visitor: New Page Rendered

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 分享你的想法与问题。

欢迎

Shirone × Znfooe

1. 创建新文章#

2. Frontmatter 规范#

示例#

支持的 frontmatter 字段#

3. 文章加密#

4. 组织文章文件#

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

单文件结构（轻量短文）#

5. 丰富的 Markdown 与 MDX 扩展#

5.1 Admonition 提示框#

5.2 GitHub 仓库卡片#

5.3 Expressive Code 代码块#

5.4 数学排版（KaTeX）#

5.5 Mermaid 图表#

5.6 图片画廊与 Fancybox 灯箱#

6. 下一步与自定义#

继续阅读

换条路线

Shirone × Znfooe

1. 创建新文章#

2. Frontmatter 规范#

示例#

支持的 frontmatter 字段#

3. 文章加密#

4. 组织文章文件#

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

单文件结构（轻量短文）#

5. 丰富的 Markdown 与 MDX 扩展#

5.1 Admonition 提示框#

5.2 GitHub 仓库卡片#

5.3 Expressive Code 代码块#

5.4 数学排版（KaTeX）#

5.5 Mermaid 图表#

5.6 图片画廊与 Fancybox 灯箱#

6. 下一步与自定义#

分享文章

沿着主题读

换条路线