Scribe

Studio

提供一个本地控制台,帮助您浏览内容、进行全文搜索、预览 MDX 正文、审查翻译状态,并安全地删除内容条目。

View as Markdown
scribe studio            # http://127.0.0.1:3600
scribe studio --port 4000

Studio(控制台)是一款本地开发工具:基于服务端渲染的 HTML,无需构建步骤或身份验证,直接读取您当前工作目录下的实时文件。无论是人类开发者还是 AI 代理,都在直接编辑文件,而 Studio 则是让用户可视化查看并核验 Scribe 管理的所有内容的统一面板。您可以在这里浏览内容集合,查看解析了关联和资源预览的条目详情,揪出失效或丢失的图片,以及在修改内容前确认“这处内容被谁引用了?”。此外,它还集成了翻译仪表板(包含覆盖率、待办列表以及文档快照,详情见 translation)。

内容集合浏览

访问 /types/:typeId 时,侧边栏会列出所有内容类型、条目数量以及聚合的问题徽标。在条目表格中,您可以查看到各个内容的标识符(slug),以及由数据结构自动推导出的关键字段(枚举值与关联关系以标签形式展示),同时配有翻译状态指示点和独立的校验提示。

字段过滤器同样基于数据结构自省生成,且以 URL 参数形式生效(方便分享链接和进行服务端渲染):枚举字段会被转换为下拉框,关联字段变为目标条目的下拉列表,布尔值呈现为开关切换,字符串则支持模糊匹配搜索。

对于任何至少包含一个资源字段的内容类型,可以将表格视图切换为画廊卡片网格;每张卡片展示主图、标识符、关键字段及状态徽标。过滤器的生效逻辑在画廊模式下完全一致。这简直是审核生成图片质量的绝佳“审查墙”。

条目检查器

访问 /types/:typeId/:enSlug,该页面会根据字段自动探测出的类型分类渲染内容:

  • 需翻译内容:显示包含语言切换器的文本内容(数据来源于底层存储库);若某个语言版本暂缺翻译,会清晰标识回退展示的英文内容。
  • 结构化数据:显示纯粹的固定值。
  • 关联关系:呈现为一个可跳转至目标条目的链接;断链的引用会显示醒目的红色徽标。
  • 资源:展示包含解析后 URL、文件体积和尺寸信息的图片预览;文件丢失时会亮起红灯报警。
  • 被谁引用:反向引用区块,列出所有(不论是何种内容类型)关联指向当前项的条目。
  • 正文:提供“源码 / 预览”切换按钮(?body=preview)。预览模式下,能够正确渲染 Markdown 和 GFM,遇到无法识别的 JSX 组件,会以带参数标注的占位框形式展示;关联类型的占位符将转化为可点击的链接(死链一目了然),资源占位符也会渲染为真实图片。对于配置了路由的类型,还会出现“在网站上查看”的快捷链接。

方向键支持条目间的快速跳转:按下 ArrowLeftArrowRight 可以基于当前集合的默认排序规则,移动至同一内容类型的上一个或下一个条目(不支持循环跳转)。跳转时会保留当前语言环境及正文视图参数。输入框处于激活状态时,方向键快捷跳转会被屏蔽。

资源浏览器

/assets 页面下,会按不同的托管根目录以缩略图网格的形式进行分类展示。每一个资源都会列出其预览图、路径、文件体积、尺寸,以及被谁引用的具体清单。这个清单由系统内存里的运行状态实时计算,列出所有指向该资源的条目和对应字段。相关的状态徽标会标出未被引用的资源(可作为孤儿清理的候选者)、被引用但文件丢失的资源、超大文件(超出字段设置的 maxKB)以及格式漂移的问题。详细的字段底层系统解析请参阅 assets

全局搜索

/search?q= 提供针对英文标识符(slug)、所有前置元数据以及未经解析的 MDX 原文正文的不区分大小写的子串匹配检索。整个平台的各个页面都提供了此搜索框。结果将依据不同的内容类型进行归类,并高亮展示匹配的文本片段,每种类型最多展示 20 条结果。

删除内容条目

在检查器工具栏里,设有一个采用危险操作样式的删除按钮。点击后,系统会打开一个专门的确认页面,按区块详细列示完整的删除计划清单(如级联删除、解除关联的操作、受波及的资源文件、各个语言版本在存储库中的计数,以及各种无法删除的阻碍项)。在这之后,页面上才是一个红色的确认按钮(或者当删除计划受阻时,只显示拦截原因而不提供确认操作)。点击确认即意味着严格按照该计划行事:只清理相应的源文件、附属资源、存储里的翻译内容及快照,还有因解除关联产生的覆写动作,其他一切不受影响。删除计划的具体运作机制由关联字段的 onTargetDelete 模式(可选 restrict 限制、detach 解除或 cascade 级联)以及资源文件的 onDelete 模式所主导。在命令行环境里,您同样可以使用 scribe delete 来执行同一套删除计划。这是 Studio 里唯一具备修改系统状态能力的路由口子,且永远仅限于在本地(localhost)环境中使用。

Studio 不支持的功能

不支持内容编辑、发起翻译请求、图片上传、身份验证或是真实的 MDX 组件渲染。请继续在您习惯的编辑器里完成内容编辑和 Git 提交流程;Studio 仅仅是用于内容审查和确认的工具。

Studio · Scribe