在 AstroPaper 主题中添加新文章

这里有一些在 AstroPaper 博客主题中创建新文章的规则、建议和技巧。

Table of contents

创建博客文章

要撰写新的博客文章，需要在 src/data/blog/ 目录中创建一个 markdown 文件。

在 AstroPaper v5.1.0 之前，所有博客文章都必须放在 src/data/blog/ 中，这意味着你无法将它们组织到子目录中。

从 AstroPaper v5.1.0 开始，你现在可以将博客文章组织到子目录中，使内容管理更加容易。

例如，如果你想将文章归类到 2025 下，可以将它们放在 src/data/blog/2025/ 中。这也会影响文章的 URL，因此 src/data/blog/2025/example-post.md 将可以在 /posts/2025/example-post 访问。

如果你不想让子目录影响文章 URL，只需在文件夹名称前加上下划线 _。

# 示例：博客文章结构和 URL
src/data/blog/very-first-post.md          -> mysite.com/posts/very-first-post
src/data/blog/2025/example-post.md        -> mysite.com/posts/2025/example-post
src/data/blog/_2026/another-post.md       -> mysite.com/posts/another-post
src/data/blog/docs/_legacy/how-to.md      -> mysite.com/posts/docs/how-to
src/data/blog/Example Dir/Dummy Post.md   -> mysite.com/posts/example-dir/dummy-post

提示：你也可以在 frontmatter 中覆盖博客文章的 slug。详情请参阅下一节。

如果子目录 URL 没有出现在构建输出中，请删除 node_modules，重新安装包，然后重新构建。

Frontmatter

Frontmatter 是存储博客文章（文章）一些重要信息的主要位置。Frontmatter 位于文章顶部，以 YAML 格式编写。在 astro 文档中了解更多关于 frontmatter 及其用法的信息。

以下是每篇文章的 frontmatter 属性列表。

提示！你可以在控制台运行 new Date().toISOString() 来获取 ISO 8601 日期时间。确保删除引号。

只有 title、description 和 pubDatetime 字段在 frontmatter 中必须指定。

标题和描述（摘要）对搜索引擎优化（SEO）很重要，因此 AstroPaper 鼓励在博客文章中包含这些内容。

slug 是 URL 的唯一标识符。因此，slug 必须唯一且与其他文章不同。slug 的空格应该用 - 或 _ 分隔，但建议使用 -。Slug 是使用博客文章文件名自动生成的。但是，你可以在博客文章中将 slug 定义为 frontmatter。

例如，如果博客文件名是 adding-new-post.md 并且你没有在 frontmatter 中指定 slug，Astro 将使用文件名自动为博客文章创建 slug。因此，slug 将是 adding-new-post。但如果你在 frontmatter 中指定了 slug，这将覆盖默认的 slug。你可以在 Astro 文档中了解更多信息。

如果你在博客文章中省略 tags（换句话说，如果没有指定任何标签），则默认标签 others 将用作该文章的标签。你可以在 content.config.ts 文件中设置默认标签。

export const blogSchema = z.object({
  // ...
  draft: z.boolean().optional(),
  tags: z.array(z.string()).default(["others"]), // 将 "others" 替换为你想要的任何内容
  // ...
});src/content.config.ts

示例 Frontmatter

以下是文章的示例 frontmatter。

---
title: The title of the post
author: your name
pubDatetime: 2022-09-21T05:17:19Z
slug: the-title-of-the-post
featured: true
draft: false
tags:
  - some
  - example
  - tags
ogImage: ../../assets/images/example.png # src/assets/images/example.png
# ogImage: "https://example.org/remote-image.png" # 远程 URL
description: This is the example description of the example post.
canonicalURL: https://example.org/my-article-was-already-posted-here
---src/data/blog/sample-post.md

添加目录

默认情况下，文章（article）不包含任何目录（toc）。要包含 toc，你必须以特定方式指定它。

以 h2 格式（markdown 中的 ##）编写 Table of contents，并将其放置在你希望它出现在文章中的位置。

例如，如果你想把目录放在简介段落下面（像我通常做的那样），你可以这样做：

---
# frontmatter
---

这里有一些在 AstroPaper 博客主题中创建新文章的建议和技巧。

## Table of contents

<!-- 文章的其余部分 -->

标题

关于标题有一点需要注意。AstroPaper 博客文章使用标题（frontmatter 中的 title）作为文章的主标题。因此，文章中的其余标题应该使用 h2 ~ h6。

这条规则不是强制性的，但出于视觉、可访问性和 SEO 目的，强烈建议这样做。

语法高亮

AstroPaper 使用 Shiki 作为默认语法高亮。从 AstroPaper v5.4 开始，使用 @shikijs/transformers 来增强更好的围栏代码块。如果你不想使用它，可以简单地像这样删除它：

pnpm remove @shikijs/transformers

// ...
import {
  transformerNotationDiff,
  transformerNotationHighlight,
  transformerNotationWordHighlight,
} from "@shikijs/transformers";

export default defineConfig({
  // ...
  markdown: {
    remarkPlugins: [remarkToc, [remarkCollapse, { test: "Table of contents" }]],
    shikiConfig: {
      themes: { light: "min-light", dark: "night-owl" },
      defaultColor: false,
      wrap: false,
      transformers: [
        transformerFileName(),
        transformerNotationHighlight(),
        transformerNotationWordHighlight(),
        transformerNotationDiff({ matchAlgorithm: "v3" }),
      ],
    },
  },
  // ...
}astro.config.ts

存储博客内容图片

这里有两种存储图片并在 markdown 文件中显示它们的方法。

注意！如果需要在 markdown 中设置优化图片的样式，你应该使用 MDX。

在 src/assets/ 目录中（推荐）

你可以在 src/assets/ 目录中存储图片。这些图片将通过 Image Service API 被 Astro 自动优化。

你可以使用相对路径或别名路径（@/assets/）来提供这些图片。

示例：假设你想显示 example.jpg，其路径为 /src/assets/images/example.jpg。

![something](@/assets/images/example.jpg)

<!-- 或 -->

![something](../../assets/images/example.jpg)

<!-- 使用 img 标签或 Image 组件无效 ❌ -->
<img src="@/assets/images/example.jpg" alt="something">
<!-- ^^ 这是错误的 -->

技术上，你可以将图片存储在 src 下的任何目录中。在这里，src/assets 只是一个建议。

在 public 目录中

你可以在 public 目录中存储图片。请记住，存储在 public 目录中的图片不会被 Astro 处理，这意味着它们不会被优化，你需要自己处理图片优化。

对于这些图片，你应该使用绝对路径；这些图片可以使用 markdown 注释或 HTML img 标签显示。

示例：假设 example.jpg 位于 /public/assets/images/example.jpg。

![something](/assets/images/example.jpg)

<!-- 或 -->

<img src="/assets/images/example.jpg" alt="something">

额外提示

图片压缩

当你在博客文章中放置图片（特别是 public 目录下的图片）时，建议对图片进行压缩。这会影响网站的整体性能。

我推荐的图片压缩网站：

• TinyPng
• TinyJPG

OG 图片

如果文章没有指定 OG 图片，将放置默认的 OG 图片。虽然不是必需的，但应该在 frontmatter 中指定与文章相关的 OG 图片。OG 图片的推荐尺寸是 1200 X 640 px。

从 AstroPaper v1.4.0 开始，如果未指定，OG 图片将自动生成。查看公告。