使用示例#

语法格式#

1
::github{repo="用户名/仓库名"}

• repo 参数：必填，格式为「GitHub 用户名/仓库名称」（如 olinll/Mizuki）

支持类型及示例#

基础语法#

1
:::类型标识
2
提示框内容（支持换行）
3
:::

自定义标题#

可修改提示框默认标题，语法如下：

1
:::note[我的自定义标题]
2
这是一个带有自定义标题的说明提示框。
3
:::

我的自定义标题

这是一个带有自定义标题的说明提示框。

GitHub 兼容语法#

同时支持 GitHub 官方提示框语法（无缝适配 GitHub 文档风格）：

1
> [!NOTE]
2
> GitHub 语法的说明提示框。
3
> 支持多行内容。
4

5
> [!TIP]
6
> GitHub 语法的技巧提示框。

效果

NOTE

GitHub 语法的说明提示框。 支持多行内容。

TIP

GitHub 语法的技巧提示框。

使用示例#

1
这是普通文本，剧透内容：:spoiler[被隐藏的**剧透内容**（支持粗体等 Markdown 语法）]！

效果：这是普通文本，剧透内容：被隐藏的剧透内容（支持粗体等 Markdown 语法）！

语法格式#

1
:spoiler[剧透内容（可包含 Markdown 语法）]

必需字段#

• title：文章标题（必需）
• description：文章描述（必需）

发布相关#

• published：文章发布日期，格式为（YYYY-MM-DD）
• pubDate：文章发布日期（与published类似）
• date：文章创建日期
• draft：是否为草稿，true表示草稿，false表示正式发布
• permalink: 固定链接

内容分类#

• tags：文章标签数组，用于标记文章主题
• category：文章分类，用于组织文章
• pinned：是否置顶文章，true表示置顶
• alias：设置别名，帖子将通过自定义网址访问

设置别名后

• 文章将可以通过自定义 URL 访问（例如 /posts/my-special-article/）
• 默认的 /posts/{slug}/ URL 仍然有效
• RSS/Atom feed 将使用自定义别名
• 所有内部链接将自动使用自定义别名

重要提示：

• 别名不应包含 /posts/ 前缀（会自动添加）
• 避免在别名中使用特殊字符和空格
• 为了最佳 SEO 实践，请使用小写字母和连字符
• 确保别名在所有文章中是唯一的
• 不要包含开头或结尾的斜杠

作者信息#

• author：文章作者姓名
• licenseName：文章许可证名称，如”MIT”、“CC BY 4.0”等
• sourceLink：文章源链接，通常指向GitHub仓库或原始来源

常见的许可证名称

• “MIT”
• “Apache-2.0”
• “CC BY 4.0”
• “CC BY-SA 4.0”
• “Unlicensed”

图片设置#

• image：文章封面图片

• 在frontmatter下方编写文章内容，可以使用标准的Markdown语法。