Skip to content

📝 文章

你的文章只需要使用 markdown 进行撰写,直接放在 posts 文件夹下,SuzuBlog 会自动对你的文章进行渲染,文件名即位你的的文章链接。

每篇文章都应该包含一个 Frontmatter,用于设置文章的基本信息和显示效果。

🔖 什么是 Frontmatter?

Frontmatter 是 Markdown 文件顶部的元数据块,使用三条短划线包裹,例如:

yaml
---
title: '示例文章'
date: '2024-12-08'
author: 'ZL Asica'
thumbnail: '/images/example-thumbnail.jpg'
tags:
  - SuzuBlog
  - Frontmatter
categories:
  - 教程
redirect: '/example-redirect'
showComments: true
showLicense: true
autoSlug: true
---

🛠️ Frontmatter 字段解释

必填字段

  • title: 文章标题,将显示在页面标题和摘要中。
  • date: 文章发布日期,格式为 YYYY-MM-DD。(若未设置,将使用文件最后修改日期)
  • author: 作者名称,用于标记文章的作者。(若未设置,将使用全局作者名称)
  • thumbnail: 文章的缩略图路径,可以是相对路径或完整 URL。(若未设置,将使用默认缩略图,在 config.yml 中设置)

选填字段

  • tags: 文章标签数组,用于对文章进行标签分类(例如 ["Tag1", "Tag2"])。
  • categories: 文章分类数组,用于更高层次的内容组织(例如 ["Category1", "Category2"])。
  • redirect: 设置文章的跳转地址(例如 "/new-url"),适用于需要重定向的文章。(填写后,文章将不会显示内容,而是直接跳转到指定地址)
  • showComments: 是否显示评论功能,默认为 true
  • showLicense: 是否显示文章的版权声明,默认为 true
  • showThumbnail: 是否显示文章的缩略图,默认为 true
  • autoSlug: 是否自动生成文章的层级路径,默认为 true。(若设置为 false,将不会自动生成文章的层级路径,而是使用 markdown 文件内的标题)

✂️ 文章摘要截断

使用 <!--more--> 在文章内容中手动截断摘要,例如:

markdown
这是文章的开头部分。

`<!--more-->`

这是文章的剩余内容。
  • 如果未设置 <!--more-->,系统会自动截断能够不溢出显示在文章卡片的内容作为摘要显示。

此文档基于 CC BY 4.0 进行授权