插件和集成
插件可以自定义 Starlight 的配置、UI 和行为,同时也易于分享和重用。使用由 Starlight 团队支持的官方插件和由 Starlight 用户维护的社区插件来扩展你的网站。
官方插件
标题为“官方插件”的部分 Algolia DocSearch 使用 Algolia DocSearch 替换默认的搜索提供商 Pagefind。
社区插件
标题为“社区插件”的部分 starlight-links-validator 检查 Starlight 页面中的损坏链接。
starlight-typedoc 使用 TypeDoc 从 TypeScript 生成 Starlight 页面。
starlight-blog 为你的文档网站添加一个博客。
starlight-openapi 从 OpenAPI/Swagger 规范创建文档页面。
starlight-obsidian 在你的 Starlight 网站中发布 Obsidian vault。
starlight-image-zoom 为你的文档图片添加缩放功能。
starlight-utils 通过一系列常用工具扩展 Starlight。
starlight-view-modes 为你的文档网站添加不同的视图模式功能。
starlight-versions 为你的 Starlight 文档页面进行版本控制。
star-warp 在你的文档中快速浏览搜索结果。
starlight-heading-badges 为你的 Markdown 和 MDX 标题添加徽章。
starlight-site-graph 在页面的侧边栏中添加一个交互式的网站图谱。
starlight-sidebar-topics 将你的文档分成不同的部分,每个部分都有自己的侧边栏。
starlight-sidebar-topics-dropdown 将你的文档页面拆分为多个子页面,并通过侧边栏中的下拉菜单在它们之间切换。
starlight-cooler-credit 在目录底部为 Starlight 或 Astro 添加一个漂亮的致谢信息。
starlight-contributor-list 显示项目所有贡献者的列表。
starlight-giscus 为你的文档网站添加 Giscus 评论。
starlight-videos 通过视频指南和课程增强你的文档。
starlight-kbd 轻松记录键盘快捷键。
starlight-view-transitions 添加浏览器原生的跨文档视图过渡效果。
starlight-auto-sidebar 调整你自动生成的侧边栏分组。
starlight-llms-txt 根据 llmstxt.org 将 llms.txt 添加到你的文档网站。
starlight-toc-overview-customizer 通过可自定义的概览标题来调整 Starlight 的目录。
starlight-markdown-blocks 使用自定义块类型扩展 Starlight 的 Markdown asides 语法。
starlight-fullview-mode 折叠侧边栏并展开内容以获得全屏体验。
starlight-scroll-to-top 为你的文档网站添加一个“滚动到顶部”的按钮。
starlight-codeblock-fullscreen 为你的文档中的 Expressive Code 块添加全屏切换功能。
starlight-auto-drafts 调整草稿页面的默认行为,并在生产模式下自动移除侧边栏中指向草稿页面的链接。
社区工具和集成
标题为“社区工具和集成”的部分这些社区工具和集成可用于为你的 Starlight 网站添加功能。
FeelBack 为你的文档页面添加一个用户反馈系统。
notion-to-astro 将 Notion 导出的内容转换为 Astro Starlight 文档
astro-live-code 将你的 MDX 代码块渲染为交互式组件
starlight-i18n 用于帮助翻译 Starlight 页面的 Visual Studio Code 扩展。
starlight-package-managers 为多个包管理器快速显示 npm 相关命令。
starlight-showcases 一组用于创建展示页面的 Starlight 组件。
@hideoo/starlight-plugin 一个用于快速搭建 Starlight 插件的生成器。
starlight-to-pdf 一个将 Starlight 网站转换为 PDF 文件的命令行工具。
astro-plantuml 在 Markdown 代码块中渲染 PlantUML 内容。
astro-mermaid 在 Markdown 代码块中客户端渲染 Mermaid 内容。
astro-d2 将 D2 Markdown 代码块转换为图表。