Our docs are now built with Starlight instead of Docusaurus
a year ago
- #documentation
- #static-site-generator
- #developer-tools
- Glasskube 从 Docusaurus 切换到了 Starlight 来构建 Distr 的文档。
- Starlight 基于 Astro 构建，提供了更好的开发者体验、更快的构建时间，以及通过 Tailwind 实现更轻松的定制。
- Docusaurus 依赖 React 和 Infima，导致更新较慢且定制更困难。
- 两种框架都支持 SEO 功能，但 Starlight 的集成更加简洁高效。
- 与 Docusaurus 不同，Starlight 缺乏对营销页面和 Mermaid 图表的原生支持。
- 技术文档应当清晰、简洁、结构分明，引导用户从概念理解到实际用例。
- 图表和截图等视觉辅助工具可以增强技术文档的理解性。
- 尽管存在一些限制，Glasskube 对切换到 Starlight 的决定感到满意。