Shirone 写作与使用指南

欢迎使用 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`）、公共路径（`/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 提示块#

使用容器指令来编写说明、提示、警告和警示：

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

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. 后续步骤与自定义#

继续阅读

换条路线

Shirone

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. 后续步骤与自定义#

分享文章

沿着主题读

换条路线