Prosefly
所有框架

Prosefly × Starlight

为 Starlight 文档提供协作工作区。

让作者与开发者共同编写指南,管理支持的页面属性,并在同一次发布中审查正文与侧边栏变更。

仓库内容示例Starlight
  • astro.config.mjs
  • src/content.config.ts
  • src/content/docs/guides/overview.mdx

选中的内容文件

---
title: Project overview
description: Start here to get to know the project.
---

# Your first guide

A place for the things your team learns.
用于说明文件结构的示例,并非实时工作区。

你的文件,团队的写作空间。

使用已有的文档 Collection

扫描支持的 docsLoader 和 docsSchema 配置。常见页面属性会成为工作区中可编辑的字段。

为页面安排侧边栏位置

确认导航绑定后,可将页面加入已有的可写分组,并调整支持的手动条目顺序。自动分组沿用文件路径。

一起审查内容与导航

在 commit 或 pull request 发布前,通过 diff 查看文档及受影响的侧边栏配置。

从 Git 仓库到内容工作区。

  1. 01

    连接文档仓库

    授权 GitHub,扫描使用 Starlight 的 Astro 应用。

  2. 02

    确认 Docs 与导航

    导入工作区前,检查识别到的文档 Collection 和支持的侧边栏绑定。

  3. 03

    编写指南并检查位置

    编辑页面,选择支持的导航位置,在发布前审查所有受影响的文件。

接入前需要了解的事

原生侧边栏支持已验证的 Starlight 0.37.x 和支持的静态配置。未知版本或动态侧边栏表达式可能需要仅发布内容。移动导航条目不会移动 Markdown 文件。复杂 frontmatter 仍在 Source 中编辑。

发布后的内容保存在你的 Git 仓库。

发布前,草稿保存在 Prosefly 中。审查变更后创建 commit 或 pull request,再由网站现有的构建流程完成部署。

了解内容所有权

继续了解

配置工作区、了解发布流程,或查阅网站工具的官方文档。

了解其他框架