bsky docs

docs.bsky.app

Repositori ini berisi kode sumber untuk situs web dokumentasi pengembang Bluesky: https://docs.bsky.app

Situs ini mencakup tutorial, blog, panduan, dan dokumen referensi HTTP API untuk aplikasi Bluesky.

Dokumentasi dan spesifikasi Protokol AT adalah situs web terpisah (atproto.com) yang dikelola di https://github.com/bluesky-social/atproto-website.

Membangun Dokumen

Situs web ini dibangun menggunakan Docusaurus, generator situs web statis dalam JavaScript.

Untuk membangun situs, pertama-tama Anda perlu menginstal node.js dan npm secara lokal. Jalankan npm install untuk mengambil dependensi.

Untuk menjalankan server pengembangan lokal (yang dapat Anda telusuri di http://localhost:3000):

 npm start

Untuk menjalankan build statis (output dalam ./build/ ):

 npm run build

Outputnya dapat disajikan menggunakan layanan hosting konten statis apa pun.

Memperbarui Referensi API HTTP

Kami menggunakan versi atproto-openapi-types yang bercabang untuk menghasilkan skema OpenAPI dari leksikon atproto. Kami menggunakan plugin docusaurus-openapi-docs untuk mengonversi skema OpenAPI yang dihasilkan menjadi file MDX.

Menjalankan proses pembuatan MDX memerlukan deno .

Kode sumber untuk pembantu ini ada di ./atproto-openapi-types/ .

File Lexicon mentah ada di atproto-openapi-types/lexicons/ , dengan skrip pembantu ( get-lexicons.sh ) yang dijalankan secara otomatis oleh Github CI setiap hari.

Untuk membuat ulang file OpenAPI:

 deno task run

Untuk membuat ulang semua file MDX dari file skema OpenAPI:

 npm run clear-and-gen-api-docs

Anda dapat menguji apakah hasilnya valid:

 npx docusaurus-mdx-checker

Kemudian Anda biasanya memeriksa apakah seluruh situs masih dapat dibangun (ini lambat):

 # local dev server for preview
npm start

# or for a static build
npm run build

Lisensi Dokumen

Teks dokumentasi berada di bawah Creative Commons Attribution (CC-BY).

Contoh kode sebaris, contoh data, dan ekspresi reguler berada di bawah Creative Commons Zero (CC-0, alias Domain Publik) dan disalin/ditempel tanpa atribusi.

Silakan lihat LICENSE.txt dengan pengingat tentang karya turunan, dan LICENSE-CC-BY.txt untuk salinan teks hukum lisensi.