bsky docs

docs.bsky.app

Ce référentiel contient le code source du site Web de documentation pour les développeurs Bluesky : https://docs.bsky.app

Ce site comprend des didacticiels, un blog, des guides et des documents de référence sur l'API HTTP pour l'application Bluesky.

La documentation et les spécifications du protocole AT constituent un site Web distinct (atproto.com) géré à l'adresse https://github.com/bluesky-social/atproto-website.

Construire les documents

Ce site Web est construit à l'aide de Docusaurus, un générateur de sites Web statiques en JavaScript.

Pour créer le site, vous aurez d’abord besoin de node.js et npm installés localement. Exécutez npm install pour récupérer les dépendances.

Pour exécuter un serveur de développement local (que vous pouvez parcourir sur http://localhost:3000) :

 npm start

Pour exécuter une build statique (sortie dans ./build/ ) :

 npm run build

La sortie peut être diffusée à l’aide de n’importe quel service d’hébergement de contenu statique.

Mise à jour de la référence de l'API HTTP

Nous utilisons une version forkée des atproto-openapi-types pour générer un schéma OpenAPI à partir des lexiques atproto. Nous utilisons le plugin docusaurus-openapi-docs pour convertir le schéma OpenAPI résultant en fichiers MDX.

L’exécution du processus de génération MDX nécessite deno .

Le code source de ces assistants se trouve dans ./atproto-openapi-types/ .

Les fichiers bruts Lexicon se trouvent dans atproto-openapi-types/lexicons/ , avec un script d'assistance ( get-lexicons.sh ) qui est exécuté automatiquement par Github CI chaque jour.

Pour régénérer le fichier OpenAPI :

 deno task run

Pour régénérer tous les fichiers MDX à partir du fichier de schéma OpenAPI :

 npm run clear-and-gen-api-docs

Vous pouvez tester que la sortie est valide :

 npx docusaurus-mdx-checker

Ensuite, vous vérifierez généralement que l'ensemble du site peut encore être construit (c'est lent) :

 # local dev server for preview
npm start

# or for a static build
npm run build

Licence Documents

Le texte de la documentation est sous Creative Commons Attribution (CC-BY).

Les exemples de code en ligne, les exemples de données et les expressions régulières sont sous Creative Commons Zero (CC-0, alias Public Domain) et copiés/collés sans attribution.

Veuillez consulter LICENSE.txt avec des rappels sur les œuvres dérivées, et LICENSE-CC-BY.txt pour une copie du texte juridique de la licence.