WindHolm 使用指南

这个模板基于 Astro 构建。这里先把最常用的用法放在前面，剩下的细节可以再去看 Astro 文档。

文章的 Frontmatter#

1
---
2
title: 我的第一篇博客文章
3
published: 2023-09-09
4
description: 这是我新 Astro 博客的第一篇文章。
5
image: ./cover.jpg
6
tags: [前端, 开发]
7
category: 前端开发
8
draft: false
9
---

属性	描述
`title`	文章标题。
`published`	文章发布日期。
`pinned`	是否将此文章置顶在文章列表顶部。
`description`	文章的简短描述。显示在首页上。
`image`	文章封面图片路径。 1. 以 `http://` 或 `https://` 开头：使用网络图片 2. 以 `/` 开头：`public` 目录中的图片 3. 不带任何前缀：相对于 markdown 文件的路径
`tags`	文章标签。
`category`	文章分类。
`licenseName`	文章内容的许可证名称。
`author`	文章作者。
`sourceLink`	文章内容的来源链接或参考。
`draft`	如果这篇文章仍是草稿，则不会显示。
`slug`	自定义文章 URL 路径。如果不设置，将使用文件名作为 URL。

文章文件的放置位置#

您的文章文件应放置在 src/content/posts/ 目录中。您也可以创建子目录来更好地组织您的文章和资源。

1
src/content/posts/
2
├── post-1.md
3
└── post-2/
4
    ├── cover.png
5
    └── index.md

自定义文章 URL (Slug)#

什么是 Slug？#

Slug 是文章 URL 路径的自定义部分。如果不设置 slug，系统将使用文件名作为 URL。

Slug 使用示例#

示例 1：使用文件名作为 URL#

1
---
2
title: 我的第一篇博客文章
3
published: 2023-09-09
4
---

文件：src/content/posts/my-first-blog-post.md URL：/posts/my-first-blog-post

示例 2：自定义 Slug#

1
---
2
title: 我的第一篇博客文章
3
published: 2023-09-09
4
slug: hello-world
5
---

文件：src/content/posts/my-first-blog-post.md URL：/posts/hello-world

示例 3：中文标题使用英文 Slug#

1
---
2
title: 如何使用 Firefly 博客主题
3
published: 2023-09-09
4
slug: how-to-use-firefly-blog-theme
5
---

文件：src/content/posts/firefly-guide.md URL：/posts/how-to-use-firefly-blog-theme

Slug 使用建议#

使用英文和连字符：my-awesome-post 而不是 my awesome post
保持简洁：避免过长的 slug
具有描述性：让 URL 能够反映文章内容
避免特殊字符：只使用字母、数字和连字符
保持一致性：在整个博客中使用相似的命名模式

注意事项#

Slug 一旦设置并发布，建议不要随意更改，以免影响 SEO 和已存在的链接
如果多个文章使用相同的 slug，后面的文章会覆盖前面的
Slug 会自动转换为小写

文章命名与分类建议#

如果你想让整站文章看起来更统一，可以尽量按下面的方式来写。

命名建议#

标题尽量短一点，优先让读者一眼看懂内容
教程类文章可以用“主题 + 入门 / 笔记 / 指南 / 速览”这类结构
项目介绍类文章可以直接用项目名作为标题，再补一个“项目介绍”
同一系列文章尽量保持命名风格一致，比如 itPlace 系列就统一成“语言名 + 入门 / 实战 / 笔记”

分类建议#

计算机科学：编程语言、算法、图形学、开发笔记
博客指南：主题使用、写作说明、站点配置
文章示例：演示型内容、语法展示、功能样例
项目介绍：实际项目、产品介绍、项目说明
前端开发：前端记录、框架实践、页面搭建

标签建议#

标签尽量少而准，控制在 3 到 5 个左右
优先用领域标签，比如 Python、Markdown、C++
再补一两个用途标签，比如 入门、实战、项目介绍
避免同义重复，比如同时写 编程、开发、代码 但内容其实差不多

这套站点里比较适合的写法#

itPlace 系列：标题统一成“语言名 + 入门 / 实战 / 笔记”
Know-Do-Bridge：标题直接用项目名，分类放 项目介绍
WindHolm 主题相关：分类放 博客指南 或 文章示例
示例文章：尽量保持轻一点，别写得像正式文档