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 以取得授權法律文字的副本。