跳转到内容

开始使用

创建一个新项目

Starlight 是一个基于 Astro 框架构建的全功能文档主题。

你可以使用以下命令创建一个新的 Astro + Starlight 项目:

# 使用 npm 创建一个新项目
npm create astro@latest -- --template starlight

这将创建一个新的 项目目录,其中包含你网站所需的所有文件和配置。

使用 Starlight 创建内容

Starlight 已经准备好让你添加新的内容,或者将你现有的文件带过来!

文件格式

Starlight 支持使用 Markdown 和 MDX 来编写内容。(你可以通过安装实验性的 Astro Markdoc 集成 来添加对 Markdoc 的支持。)

添加页面

src/content/docs/ 中创建 .md.mdx 文件,就可以自动将新页面添加到你的站点中。添加子文件夹来组织你的文件,并创建多个路径段:

src/content/docs/hello-world.md => your-site.com/hello-world
src/content/docs/guides/faq.md => your-site.com/guides/faq

类型安全的 frontmatter

所有 Starlight 页面都共享一个可自定义的 frontmatter 属性集,用于控制页面的外观:

---
title: Hello, World!
description: This is a page in my Starlight-powered site
---

如果你忘记了任何重要的东西,Starlight 会提醒你。

部署你的 Starlight 网站

一旦你创建并自定义了你的 Starlight 网站,你就可以将它部署到你选择的 web 服务器或托管平台上,包括 Netlify、Vercel、GitHub Pages 等等。

在 Astro 文档中了解如何部署 Astro 网站。

更新 Starlight

Starlight 是一个 Astro 集成,可以像任何 @astrojs/* 集成一样更新:

# 使用 npm 升级 Starlight
npm install @astrojs/starlight@latest

你可以在 Starlight 更新日志 中查看每个版本的变动列表。

Starlight 故障排除

本站点的参考部分提供了 Starlight 项目配置单个页面 frontmatter 配置信息。使用这些页面来确保你的 Starlight 网站已正确配置和运行。

请参阅侧边栏中不断增长的指南列表,以获取有关添加内容和自定义 Starlight 网站的帮助。

如果你在这些文档中找不到答案,请访问完整的 Astro 文档 以获取完整的 Astro 文档。你的问题可能是通过了解 Starlight 主题下 Astro 的工作原理来解决的。

你也可以检查任何已知的 GitHub 上的 Starlight issues,并在 Astro Discord 上从我们活跃的、友好的社区中获得帮助!在我们的 #support 论坛中发布带有 “starlight” 标签的问题,或者访问我们专门的 #starlight 频道来讨论当前的开发和更多内容!