Repolode
withastro

withastro/starlight

基于 Astro 构建的文档网站框架,用于快速搭建高性能、无障碍的文档站点。

Star
9,527
Fork
1,084
未关闭 Issue
39
最近提交
14小时前

这是什么?

Starlight 是一个基于 Astro 的文档网站框架,适合希望快速搭建完整文档站点、无需从零实现布局、导航和搜索的团队。

它提供开箱即用的文档结构,由 Astro 渲染为静态站点。Starlight 自身的官方文档也是用它构建的,可以作为实际使用的参考。

项目采用 MIT 许可证,问题反馈和功能请求可通过 GitHub issues 提交,也可以在 Astro Discord 的 #starlight 频道交流。

核心功能

  • 01基于 Astro 框架构建文档网站。
  • 02提供包含导航在内的完整文档布局。
  • 03使用 Astro 工具链输出静态站点。
  • 04支持以 Astro 内容集合格式编写的文档内容文件。

适用场景

  • 将项目的产品或 API 文档发布为网站。
  • 搭建团队知识库或内部手册。
  • 为开源库创建文档站点。

快速上手

  1. 1

    阅读 Starlight 文档以获取安装说明

使用前须知

  • README 中没有安装命令,因此安装细节需要在外部文档中查找。
  • Starlight 基于 Astro 构建,因此需要熟悉 Astro 框架。

收录于专题

标签

常见问题

starlight 是什么?
基于 Astro 构建的文档网站框架,用于快速搭建高性能、无障碍的文档站点。 Starlight 是一个基于 Astro 的文档网站框架,适合希望快速搭建完整文档站点、无需从零实现布局、导航和搜索的团队。
starlight 可以免费使用吗?用的什么许可证?
starlight 以 MIT 许可证开源。用于商业产品前,请先确认许可证条款。
starlight 还在维护吗?
活跃维护中。starlight 最近一次提交是在 2026年11月6日。
starlight 适合用来做什么?
将项目的产品或 API 文档发布为网站。 搭建团队知识库或内部手册。 为开源库创建文档站点。
starlight 怎么安装和运行?
阅读 Starlight 文档以获取安装说明
在哪里获取 starlight?
源代码和安装说明在 GitHub 上:https://github.com/withastro/starlight

概要由 AI 根据项目 README 生成;GitHub 数据每日更新。

相关项目