入门指南
Starlight 是一个功能齐全的文档主题,构建在 Astro 框架之上。本指南将帮助你开始一个新项目。要将 Starlight 添加到现有的 Astro 项目中,请参阅手动设置说明。
快速入门
标题为“快速入门”的部分创建一个新项目
标题为“创建一个新项目”的部分在终端中运行以下命令来创建一个新的 Astro + Starlight 项目
npm create astro@latest -- --template starlight
pnpm create astro --template starlight
yarn create astro --template starlight
这将在一个新的项目目录中,为你的站点创建所有必要的文件和配置。
启动开发服务器
标题为“启动开发服务器”的部分在本地工作时,Astro 的开发服务器可以让你预览你的工作,并在你进行更改时自动刷新浏览器。
在你的项目目录中,运行以下命令来启动开发服务器
npm run dev
pnpm dev
yarn dev
这将在你的终端中打印一条消息,其中包含本地预览的 URL。打开此 URL 开始浏览你的网站。
添加内容
标题为“添加内容”的部分Starlight 已准备好让你添加新内容,或引入你现有的文件!
通过在 src/content/docs/
目录中创建 Markdown 文件来为你的站点添加新页面。
在“页面”指南中阅读更多关于基于文件的路由以及对 MDX 和 Markdoc 文件的支持。
后续步骤
标题为“后续步骤”的部分- 配置: 在“自定义 Starlight”中了解常用选项。
- 导航: 使用“侧边栏导航”指南设置你的侧边栏。
- 组件: 在“组件”指南中发现内置的卡片、标签页等。
- 部署: 使用 Astro 文档中的“部署你的站点”指南来发布你的作品。
更新 Starlight
标题为“更新 Starlight”的部分Starlight 是一个 Astro 集成。你可以在终端中运行以下命令来更新它和其他 Astro 包
npx @astrojs/upgrade
pnpm dlx @astrojs/upgrade
yarn dlx @astrojs/upgrade
请参阅 Starlight 更新日志,查看每个版本中所做更改的完整列表。
Starlight 故障排除
标题为“Starlight 故障排除”的部分使用项目配置和单页 frontmatter 配置参考页面,以确保你的 Starlight 站点配置正确且功能正常。请参阅侧边栏中的指南,以获取有关添加内容和自定义 Starlight 站点的帮助。
如果在这些文档中找不到答案,请访问完整的 Astro 文档以获取完整的 Astro 文档。通过了解 Astro 在这个 Starlight 主题下的通用工作原理,你的问题可能会得到解答。
你也可以在 GitHub 上查看任何已知的 Starlight 问题,并在 Astro Discord 中从我们活跃、友好的社区获得帮助!在我们的 #support
论坛中用“starlight”标签发布问题,或访问我们专用的 #starlight
频道讨论当前的开发和更多内容!