หน้าแรก>การเขียนโปรแกรมที่เกี่ยวข้อง>ซอร์สโค้ดอื่น ๆ
ดาวน์โหลด

docs.bsky.app

พื้นที่เก็บข้อมูลนี้มีซอร์สโค้ดสำหรับเว็บไซต์เอกสารสำหรับนักพัฒนา Bluesky: https://docs.bsky.app

ไซต์นี้ประกอบด้วยบทช่วยสอน บล็อก คำแนะนำ และเอกสารอ้างอิง HTTP API สำหรับแอป Bluesky

เอกสารและข้อกำหนดของ AT Protocol เป็นเว็บไซต์แยกต่างหาก (atproto.com) ซึ่งเก็บรักษาไว้ที่ https://github.com/bluesky-social/atproto-website

การสร้างเอกสาร

เว็บไซต์นี้สร้างขึ้นโดยใช้ Docusaurus ซึ่งเป็นเครื่องมือสร้างเว็บไซต์แบบคงที่ใน JavaScript

หากต้องการสร้างไซต์ ขั้นแรกคุณจะต้องติดตั้ง node.js และ npm ในเครื่อง รัน npm install เพื่อดึงข้อมูลการอ้างอิง

หากต้องการเรียกใช้เซิร์ฟเวอร์การพัฒนาท้องถิ่น (ซึ่งคุณสามารถเรียกดูได้ที่ http://localhost:3000): 

 npm start

หากต้องการรันบิลด์แบบคงที่ (เอาต์พุตใน ./build/ ): 

 npm run build

เอาต์พุตสามารถให้บริการได้โดยใช้บริการโฮสต์เนื้อหาแบบคงที่

กำลังอัปเดตการอ้างอิง HTTP API

เราใช้ atproto-openapi-types เวอร์ชันแยกเพื่อสร้างสคีมา OpenAPI จากพจนานุกรม atproto เราใช้ปลั๊กอิน docusaurus-openapi-docs เพื่อแปลงสคีมา OpenAPI ที่เป็นผลลัพธ์เป็นไฟล์ MDX

การรันกระบวนการสร้าง MDX ต้องใช้ deno

ซอร์สโค้ดสำหรับตัวช่วยเหล่านี้อยู่ใน ./atproto-openapi-types/ -types/

ไฟล์ Lexicon แบบดิบอยู่ใน atproto-openapi-types/lexicons/ พร้อมด้วยสคริปต์ตัวช่วย ( get-lexicons.sh ) ซึ่งทำงานโดยอัตโนมัติโดย Github CI ทุกวัน

หากต้องการสร้างไฟล์ OpenAPI ใหม่: 

 deno task run

หากต้องการสร้างไฟล์ MDX ทั้งหมดใหม่จากไฟล์สคีมา OpenAPI ให้ทำดังนี้ 

 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

ใบอนุญาตเอกสาร

ข้อความเอกสารอยู่ภายใต้ Creative Commons Attribution (CC-BY)

ตัวอย่างโค้ดอินไลน์ ข้อมูลตัวอย่าง และนิพจน์ทั่วไปอยู่ภายใต้ Creative Commons Zero (CC-0 หรือที่รู้จักกันในชื่อ Public Domain) และคัดลอก/วางโดยไม่มีการระบุแหล่งที่มา

โปรดดู LICENSE.txt พร้อมคำเตือนเกี่ยวกับผลงานลอกเลียน และ LICENSE-CC-BY.txt สำหรับสำเนาข้อความทางกฎหมายของใบอนุญาต

ขยาย
ข้อมูลเพิ่มเติม
แอปที่เกี่ยวข้อง
แนะนำสำหรับคุณ
ข้อมูลที่เกี่ยวข้อง ทั้งหมด