单文件方案
约 1328 字大约 4 分钟
2025-09-01
这是在Mizuka博客系统中创建文章的两种方法之一。这种方法适用于简单的文章,不需要管理大量图片资源的情况。 单文件方案会导致RSS无法正常构建图片的路径(指本地,如果你使用图床那么不会有这个问题),如果你需要使用rss功能请使用文件夹写作方案
创建文章
在
src/content/posts目录下创建一个新的Markdown文件,文件名应该具有描述性,例如my-first-post.md。在文件中添加frontmatter(前置元数据),这是文章的配置信息,必须包含
title和description字段:
---
title: Markdown Tutorial
published: 2025-01-20
pinned: true
description: A simple example of a Markdown blog post.
tags: [Markdown, Blogging]
category: Examples
licenseName: "Unlicensed"
author: emn178
sourceLink: "https://github.com/emn178/markdown"
draft: false
date: 2025-01-20
image: "./cover.png"
pubDate: 2025-01-20
permalink: "encrypted-example"
---Frontmatter字段详解
frontmatter支持的字段包括:
必需字段
title:文章标题(必需)description:文章描述(必需)
发布相关
published:文章发布日期,格式为YYYY-MM-DDpubDate:文章发布日期(与published类似)date:文章创建日期draft:是否为草稿,true表示草稿,false表示正式发布permalink: 固定链接
内容分类
tags:文章标签数组,用于标记文章主题category:文章分类,用于组织文章pinned:是否置顶文章,true表示置顶
作者信息
author:文章作者姓名licenseName:文章许可证名称,如"MIT"、"CC BY 4.0"等sourceLink:文章源链接,通常指向GitHub仓库或原始来源
图片设置
image:文章封面图片
- 在frontmatter下方编写文章内容,可以使用标准的Markdown语法。
Markdown学习资源
如果您还不熟悉Markdown语法,建议先学习基础知识:
📚 推荐学习地址:菜鸟教程 - Markdown教程
这个教程涵盖了:
- Markdown基本语法
- 标题、段落、换行
- 字体样式(粗体、斜体等)
- 列表、链接、图片
- 代码块、表格
- 高级功能
掌握这些基础语法后,您就可以轻松编写美观的博客文章了!
Frontmatter最佳实践
日期格式
建议使用ISO 8601格式(YYYY-MM-DD)来设置日期:
published: 2025-01-20
date: 2025-01-20
pubDate: 2025-01-20标签和分类
- 标签应该具体且相关,避免过于宽泛
- 分类用于高级组织,通常比标签更宽泛
- 示例:
tags: [Vue.js, JavaScript, Frontend, Tutorial]
category: Web Development草稿管理
使用draft字段来管理文章状态:
draft: true- 文章不会在生产环境中显示draft: false- 文章正常发布
许可证设置
常见的许可证名称:
- "MIT"
- "Apache-2.0"
- "CC BY 4.0"
- "CC BY-SA 4.0"
- "Unlicensed"
完整示例
---
title: "Vue.js 3 组合式API完全指南"
published: 2025-01-20
pinned: false
description: "深入了解Vue.js 3的组合式API,包括setup函数、响应式系统和生命周期钩子。"
tags: [Vue.js, JavaScript, Frontend, API]
category: "Web Development"
licenseName: "CC BY 4.0"
author: "张三"
sourceLink: "https://github.com/zhangsan/vue3-guide"
draft: false
date: 2025-01-20
image: 'https://example.com/vue3-cover.jpg'
pubDate: 2025-01-20
---
# Vue.js 3 组合式API完全指南
在这篇文章中,我们将深入探讨Vue.js 3的组合式API...预览文章
保存文件后,可以在浏览器中预览文章。将文章文件名(不包括.md扩展名)拼接到预览URL的末尾即可查看。 例如,如果本地开发服务器运行在http://localhost:4321/,文章文件名为my-first-post.md,则可以通过http://localhost:4321/posts/my-first-post访问文章。
如果文章尚未创建或文件名错误,页面将显示404错误。当你预览一个尚未创建的文章时,控制台会显示不同的输出,这有助于进行故障排查。
链接到文章
要在博客页面或其他页面中链接到你的文章,可以使用标准的HTML <a> 标签:
<a href="/posts/my-first-post/">我的第一篇文章</a>确保链接的href属性指向正确的文章路径。
添加图片
如果需要在文章中添加图片,可以将图片文件放在public目录下,然后在文章中通过相对路径引用:
创建多篇文章
你可以在src/content/posts/目录下创建多个Markdown文件,每个文件代表一篇文章。例如:
src/content/posts/
├── my-first-post.md
├── my-second-post.md
└── my-third-post.md每篇文章都是一个独立的Markdown文件,文件名将被用作文章的URL路径。
链接多篇文章
要在博客页面中链接到多篇文章,可以创建一个文章列表:
<ul>
<li><a href="/posts/my-first-post/">我的第一篇文章</a></li>
<li><a href="/posts/my-second-post/">我的第二篇文章</a></li>
<li><a href="/posts/my-third-post/">我的第三篇文章</a></li>
</ul>确保每个链接都指向正确的文章路径。
注意事项
- 文件名将被用作文章的URL路径,所以应该具有描述性且不含特殊字符
- frontmatter中的
date字段是可选的,如果不提供,系统会使用文件的创建日期 - 这种方法适合简单的文章,但如果文章包含大量图片,建议使用子文件夹方案