bsky docs
1.0.0
このリポジトリには、Bluesky 開発者ドキュメント Web サイトのソース コードが含まれています: https://docs.bsky.app
このサイトには、Bluesky アプリのチュートリアル、ブログ、ガイド、HTTP API リファレンス ドキュメントが含まれています。
AT プロトコルのドキュメントと仕様は、https://github.com/bluesky-social/atproto-website で管理されている別の Web サイト (atproto.com) です。
この Web サイトは、JavaScript の静的 Web サイト ジェネレーターである Docusaurus を使用して構築されています。
サイトを構築するには、まず、node.js とnpmローカルにインストールする必要があります。 npm install実行して依存関係を取得します。
ローカル開発サーバーを実行するには (http://localhost:3000 で参照できます):
npm start
静的ビルドを実行するには ( ./build/に出力):
npm run build
出力は、任意の静的コンテンツ ホスティング サービスを使用して提供できます。
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 を参照してください。
