Markdown Toolbox Logo Markdown Toolbox
博客

Markdown的常见前言信息

2024-09-05

简短版

在创建markdown文档时,您可以在开头包含前置信息。它可以包含关于文档的元数据。

---
title: 文档标题
date: YYYY-MM-DD
description: 简要描述。
tags: [标签1, 标签2]
author: 您的名字
---

详细版

介绍

前置信息是一种为markdown文档定义元数据的方法。它通常被包含在三条破折号的行之间。以下是您可以如何结构化它:

前置信息的结构

您的前置信息可以包括多个字段:

  • title: 您文档的标题
  • date: 出版日期
  • description: 简要总结
  • tags: 文档相关标签的数组
  • author: 作者的名字

示例

这是一个全面的示例:

---
title: 伟大的Markdown指南
date: 2024-07-24
description: 有效使用markdown的完整指南。
tags: [Markdown, 指南, 格式]
author: Ben Maddox
---

使用前置信息可以帮助更好地组织和管理您的markdown文档,特别是在静态站点生成器中。