bsky docs

文档.bsky.app

此存储库包含 Bluesky 开发人员文档网站的源代码：https://docs.bsky.app

此站点包括 Bluesky 应用程序的教程、博客、指南和 HTTP API 参考文档。

AT 协议文档和规范是一个单独的网站 (atproto.com)，维护于 https://github.com/bluesky-social/atproto-website。

构建文档

该网站是使用 Docusaurus 构建的，Docusaurus 是一个 JavaScript 静态网站生成器。

要构建站点，首先您需要在本地安装 node.js 和npm 。运行npm install以获取依赖项。

要运行本地开发服务器（您可以在 http://localhost:3000 浏览）：

 npm start

运行静态构建（在./build/中输出）：

 npm run build

可以使用任何静态内容托管服务来提供输出。

更新 HTTP API 参考

我们使用atproto-openapi-types的分叉版本从 atproto 词典生成 OpenAPI 模式。我们使用docusaurus-openapi-docs插件将生成的 OpenAPI 架构转换为 MDX 文件。

运行 MDX 生成过程需要deno 。

这些助手的源代码位于./atproto-openapi-types/中。

原始 Lexicon 文件位于atproto-openapi-types/lexicons/中，其中包含一个帮助程序脚本 ( get-lexicons.sh )，该脚本每天由 Github CI 自动运行。

重新生成 OpenAPI 文件：

 deno task run

要从 OpenAPI 架构文件重新生成所有 MDX 文件：

 npm run clear-and-gen-api-docs

您可以测试输出是否有效：

 npx docusaurus-mdx-checker

然后您通常会检查整个站点是否仍然可以构建（这很慢）：

 # local dev server for preview
npm start

# or for a static build
npm run build

文档许可证

文档文本采用知识共享署名 (CC-BY)。

内联代码示例、示例数据和正则表达式均位于知识共享零（CC-0，又名公共领域）下，无需归属即可复制/粘贴。

请参阅 LICENSE.txt 以及有关衍生作品的提醒，并参阅 LICENSE-CC-BY.txt 以获得许可法律文本的副本。