如何配置 AstroPaper 主题

AstroPaper 是一个高度可定制的 Astro 博客主题。使用 AstroPaper，你可以根据个人喜好自定义一切。本文将解释如何在配置文件中轻松进行一些自定义。

配置 SITE

重要的配置位于 src/config.ts 文件中。在该文件中，你会看到 SITE 对象，可以在其中指定网站的主要配置。

在开发过程中，可以将 SITE.website 留空。但在生产模式下，你应该在 SITE.website 选项中指定你的部署 URL，因为这将用于规范 URL、社交卡片 URL 等，这些对 SEO 很重要。

export const SITE = {
  website: "https://astro-paper.pages.dev/", // replace this with your deployed domain
  author: "Sat Naing",
  profile: "https://satnaing.dev/",
  desc: "A minimal, responsive and SEO-friendly Astro blog theme.",
  title: "AstroPaper",
  ogImage: "astropaper-og.jpg",
  lightAndDarkMode: true,
  postPerIndex: 4,
  postPerPage: 4,
  scheduledPostMargin: 15 * 60 * 1000, // 15 minutes
  showArchives: true,
  showBackButton: true, // show back button in post detail
  editPost: {
    enabled: true,
    text: "Suggest Changes",
    url: "https://github.com/satnaing/astro-paper/edit/main/",
  },
  dynamicOgImage: true, // enable automatic dynamic og-image generation
  dir: "ltr", // "rtl" | "auto"
  lang: "en", // html lang code. Set this empty and default will be "en"
  timezone: "Asia/Bangkok", // Default global timezone (IANA format) https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
} as const;src/config.ts

以下是 SITE 配置选项

选项	描述
`website`	你的部署网站 URL
`author`	你的姓名
`profile`	你的个人/作品集网站 URL，用于更好的 SEO。如果没有，请填写 `null` 或空字符串 `""`。
`desc`	你的网站描述。对 SEO 和社交媒体分享很有用。
`title`	你的网站名称
`ogImage`	网站的默认 OG 图像。对社交媒体分享很有用。OG 图像可以是外部图像 URL，也可以放在 `/public` 目录下。
`lightAndDarkMode`	启用或禁用网站的`明暗模式`。如果禁用，将使用主要配色方案。此选项默认启用。
`postPerIndex`	在首页 `最近` 部分显示的文章数量。
`postPerPage`	你可以指定每个文章页面显示多少篇文章。（例如：如果你将 `SITE.postPerPage` 设置为 3，每页只会显示 3 篇文章）
`scheduledPostMargin`	在生产模式下，具有未来 `pubDatetime` 的文章将不可见。但是，如果文章的 `pubDatetime` 在接下来的 15 分钟内，它将可见。如果你不喜欢默认的 15 分钟边距，可以设置 `scheduledPostMargin`。
`showArchives`	决定是否在网站上显示 `归档` 菜单（位于 `关于` 和 `搜索` 菜单之间）及其对应页面。此选项默认设置为 `true`。
`showBackButton`	决定是否在每篇博客文章中显示 `返回` 按钮。
`editPost`	此选项允许用户通过在博客文章标题下提供编辑链接来建议对博客文章的更改。可以通过将 `SITE.editPost.enabled` 设置为 `false` 来禁用此功能。
`dynamicOgImage`	此选项控制如果博客文章前置元数据中未指定 `ogImage`，是否生成动态 og-image。如果你有很多博客文章，你可能想要禁用此功能。有关更多详细信息，请参阅权衡。
`dir`	指定整个博客的文本方向。用作 `<html dir="ltr">` 中的 HTML dir 属性。支持的值：`ltr` \| `rtl` \| `auto`
`lang`	用作 `<html lang"en">` 中的 HTML ISO 语言代码。默认为 `en`。
`timezone`	此选项允许你使用 IANA 格式指定时区。设置此项可确保本地主机和部署站点之间的时间戳一致，消除时间差异。

更新布局宽度

整个博客的默认 max-width 是 768px（max-w-3xl）。如果你想更改它，可以轻松更新 global.css 中的 max-w-app 实用程序。例如：

@utility max-w-app {
  @apply max-w-3xl;
  @apply max-w-4xl xl:max-w-5xl;
}src/styles/global.css

你可以在 Tailwind CSS 文档中探索更多 max-width 值。

配置 logo 或标题

在 AstroPaper v5 之前，你可以在 src/config.ts 文件中的 LOGO_IMAGE 对象中更新网站名称/logo。但是，在 AstroPaper v5 中，此选项已被移除，改为使用 Astro 的内置 SVG 和 Image 组件。

你有 3 个选项可以选择：

选项 1：SITE 标题文本

这是最简单的选项。你只需要在 src/config.ts 文件中更新 SITE.title。

选项 2：Astro 的 SVG 组件

如果你想使用 SVG logo，可能会想要使用此选项。

首先在 src/assets 目录中添加一个 SVG。（例如：src/assets/dummy-logo.svg）

然后在 Header.astro 中导入该 SVG

---
// ...
import DummyLogo from "@/assets/dummy-logo.svg";
---src/components/Header.astro

最后，用导入的 logo 替换 {SITE.title}。

<a
  href="/"
  class="absolute py-1 text-left text-2xl leading-7 font-semibold whitespace-nowrap sm:static"
>
  <DummyLogo class="scale-75 dark:invert" />
  <!-- {SITE.title} -->
</a>

这种方法的最大优点是你可以根据需要自定义 SVG 样式。在上面的示例中，你可以看到如何在暗黑模式下反转 SVG logo 颜色。

选项 3：Astro 的 Image 组件

如果你的 logo 是图像但不是 SVG，可以使用 Astro 的 Image 组件。

在 src/assets 目录中添加你的 logo。（例如：src/assets/dummy-logo.png）

在 Header.astro 中导入 Image 和你的 logo

---
// ...
import { Image } from "astro:assets";
import dummyLogo from "@/assets/dummy-logo.png";
---src/components/Header.astro

然后，用导入的 logo 替换 {SITE.title}。

<a
  href="/"
  class="absolute py-1 text-left text-2xl leading-7 font-semibold whitespace-nowrap sm:static"
>
  <image src="{dummyLogo}" alt="Dummy Blog" class="dark:invert" />
  <!-- {SITE.title} -->
</a>

使用这种方法，你仍然可以使用 CSS 类调整图像的外观。但是，这可能并不总是符合你的要求。如果你需要根据明暗模式显示不同的 logo 图像，请查看 Header.astro 组件中如何处理明暗图标。

配置社交链接

指向社交链接图标的箭头

你可以在 constants.ts 中的 SOCIALS 对象中配置社交链接。

export const SOCIALS = [
  {
    name: "GitHub",
    href: "https://github.com/satnaing/astro-paper",
    linkTitle: ` ${SITE.title} on GitHub`,
    icon: IconGitHub,
  },
  {
    name: "X",
    href: "https://x.com/username",
    linkTitle: `${SITE.title} on X`,
    icon: IconBrandX,
  },
  {
    name: "LinkedIn",
    href: "https://www.linkedin.com/in/username/",
    linkTitle: `${SITE.title} on LinkedIn`,
    icon: IconLinkedin,
  },
  {
    name: "Mail",
    href: "mailto:yourmail@gmail.com",
    linkTitle: `Send an email to ${SITE.title}`,
    icon: IconMail,
  },
] as const;src/constants.ts

配置分享链接

你可以在 src/constants.ts 中的 SHARE_LINKS 对象中配置分享链接。

指向分享链接图标的箭头

结论

这是如何自定义此主题的简要说明。如果你懂一些编程，可以进行更多自定义。有关自定义样式，请阅读这篇文章。感谢阅读。✌🏻