跳到主要内容

介绍

最后更新于:

介绍

Starlight 是由 Astro 官方团队开发的 专业文档主题,专为快速构建高性能、现代化、支持多语言的技术文档网站而设计。

一、核心定位与优势

  • 定位:零配置、开箱即用的 文档站 (Documentation) 专用主题。
  • 技术栈:基于 Astro 4.x,纯静态输出(SSG),极致速度。
  • 核心优势SEO 友好、无障碍 (a11y)、深色模式、全文搜索、多语言

二、核心功能特性

  1. 内容与写作
    • 支持 Markdown / MDX / Markdoc,可直接写 React/Vue/Svelte 组件。
    • 内置 代码高亮、标题锚点、侧边目录、上/下页导航
    • 文件路由:src/content/docs/xx.md 自动生成页面。
  2. 导航与布局
    • 自动生成 侧边栏、顶部导航、面包屑
    • 可折叠菜单、分组、自定义链接。
    • 移动端友好、响应式设计。
  3. 国际化 (i18n)
    • 一键配置多语言(中/英/日/韩等)。
    • 自动语言切换器、URL 路由(/zh-cn//en/)。
  4. 搜索
    • 内置 离线全文搜索(无需后端)。
    • 支持跨语言、标题/内容精准匹配。
  5. 主题与样式
    • 明/暗色模式自动切换
    • 大量 CSS 变量(--sl-color-*--sl-content-width)可一键换肤。
    • 支持自定义 CSS、Tailwind 集成。
  6. SEO 与性能
    • 自动生成 sitemap、robots.txt、Open Graph
    • 零 JS 核心页面,Lighthouse 满分。
  7. 扩展能力
    • 可替换内置组件(Header、Footer、Search 等)。
    • 兼容所有 Astro 集成(Tailwind、Vue、React、Svelte 等)。

三、适用场景

  • 技术库/SDK 文档
  • API 文档
  • 产品手册、帮助中心
  • 个人博客(文档型)
  • 团队知识库

四、与其他文档工具对比

  • 优于 Docusaurus:更轻、更快、构建更快、JS 体积更小
  • 优于 VitePress:Astro 生态更强、多语言更成熟、支持 MDX/组件更自由
  • 优于 Docsify:纯静态、SEO 更好、功能更完整

五、官方资源

  • 官网(中文):https://starlight.astro.build/zh-cn/
  • GitHub:https://github.com/withastro/starlight
  • 主题:https://astro.build/themes/details/starlight/

要不要我帮你生成一份可直接使用的 Starlight 配置文件(含中文、侧边栏、自定义样式)?

最新文章

文档导航