bsky docs

docs.bsky.aplicación

Este repositorio contiene el código fuente del sitio web de documentación para desarrolladores de Bluesky: https://docs.bsky.app

Este sitio incluye tutoriales, un blog, guías y documentos de referencia de la API HTTP para la aplicación Bluesky.

La documentación y las especificaciones del protocolo AT se encuentran en un sitio web independiente (atproto.com) mantenido en https://github.com/bluesky-social/atproto-website.

Construyendo los documentos

Este sitio web está construido utilizando Docusaurus, un generador de sitios web estáticos en JavaScript.

Para crear el sitio, primero necesitará node.js y npm instalados localmente. Ejecute npm install para recuperar las dependencias.

Para ejecutar un servidor de desarrollo local (que puede explorar en http://localhost:3000):

 npm start

Para ejecutar una compilación estática (salida en ./build/ ):

 npm run build

La salida se puede servir utilizando cualquier servicio de alojamiento de contenidos estáticos.

Actualización de la referencia de la API HTTP

Usamos una versión bifurcada de atproto-openapi-types para generar un esquema OpenAPI a partir de léxicos atproto. Usamos el complemento docusaurus-openapi-docs para convertir el esquema OpenAPI resultante en archivos MDX.

La ejecución del proceso de generación de MDX requiere deno .

El código fuente de estos ayudantes se encuentra en ./atproto-openapi-types/ .

Los archivos sin procesar de Lexicon están en atproto-openapi-types/lexicons/ , con un script auxiliar ( get-lexicons.sh ) que Github CI ejecuta automáticamente todos los días.

Para volver a generar el archivo OpenAPI:

 deno task run

Para volver a generar todos los archivos MDX desde el archivo de esquema OpenAPI:

 npm run clear-and-gen-api-docs

Puede probar que la salida es válida:

 npx docusaurus-mdx-checker

Luego, normalmente comprobarías que todo el sitio aún se puede construir (esto es lento):

 # local dev server for preview
npm start

# or for a static build
npm run build

Licencia de documentos

El texto de la documentación está bajo Creative Commons Attribution (CC-BY).

Los ejemplos de código en línea, los datos de ejemplo y las expresiones regulares se encuentran bajo Creative Commons Zero (CC-0, también conocido como dominio público) y se copian y pegan sin atribución.

Consulte LICENSE.txt para obtener recordatorios sobre trabajos derivados y LICENSE-CC-BY.txt para obtener una copia del texto legal de la licencia.