快速入门
开始使用 Chirping Astro:配置网站、撰写文章与部署博客。
指南1分钟阅读
欢迎来到你的新博客!本文介绍 Chirping Astro 的基本用法。
打开 src/config.ts,修改以下设置:
- title:网站或博客名称。
- description:用于搜索引擎和 RSS 的网站描述。
- author.name:侧栏和页脚显示的作者名称。
- url:正式网站地址,也可以通过
SITE_URL环境变量配置。
将 .env.example 复制为 .env。在 PowerShell 中执行:
Copy-Item .env.example .env| 变量 | 用途 |
|---|---|
SITE_URL |
正式网站地址,例如 https://myblog.com |
BASE_PATH |
GitHub Pages 项目站点使用 /<仓库名>,其他情况通常留空 |
PUBLIC_GITHUB_HANDLE |
在侧栏显示 GitHub 链接 |
PUBLIC_GISCUS_* |
配置 Giscus 评论系统,参见 配置页面 |
在 src/content/posts/zh/ 中创建 Markdown 文件:
---title: '我的第一篇文章'description: '用于搜索引擎和文章列表的简短描述。'pubDate: 2026-05-03tags: [标签一, 标签二]categories: [分类]translationKey: my-first-post---
在这里使用 Markdown 撰写正文。| 字段 | 必填 | 说明 |
|---|---|---|
title |
是 | 文章标题,1–140 个字符 |
description |
是 | 文章描述,1–280 个字符 |
pubDate |
是 | ISO 格式的发布日期 |
tags |
否 | 标签数组 |
categories |
否 | 分类数组 |
heroImage |
否 | 文章封面图片路径 |
pinned |
否 | 在列表中置顶 |
toc |
否 | 显示目录 |
draft |
否 | 在生产构建中隐藏文章 |
translationKey |
否 | 与英文版本共享的翻译标识 |
英文内容位于网站根路径,中文内容位于 /zh/。在 src/content/posts/en/ 和 src/content/posts/zh/ 中分别创建文章,并设置相同的 translationKey,即可通过语言切换器访问对应版本。
主题附带的 GitHub Pages 工作流可以在推送到 GitHub 的 main 分支后构建并部署网站。使用自定义域名时,在仓库的 Settings → Environments → github-pages 中配置 SITE_URL。
如果使用其他托管平台,请按对应平台配置构建和发布设置。
开始发布自己的文章后,可以删除这篇示例文章。