bsky docs

docs.bsky.app

Este repositório contém o código-fonte do site de documentação do desenvolvedor Bluesky: https://docs.bsky.app

Este site inclui tutoriais, um blog, guias e documentos de referência da API HTTP para o aplicativo Bluesky.

A documentação e especificações do protocolo AT estão em um site separado (atproto.com) mantido em https://github.com/bluesky-social/atproto-website.

Construindo os documentos

Este site foi construído usando Docusaurus, um gerador de sites estáticos em JavaScript.

Para construir o site, primeiro você precisará do node.js e npm instalados localmente. Execute npm install para buscar dependências.

Para executar um servidor de desenvolvimento local (que você pode navegar em http://localhost:3000):

 npm start

Para executar uma compilação estática (saída em ./build/ ):

 npm run build

A saída pode ser servida usando qualquer serviço de hospedagem de conteúdo estático.

Atualizando Referência da API HTTP

Usamos uma versão bifurcada de atproto-openapi-types para gerar um esquema OpenAPI a partir de léxicos atproto. Usamos o plugin docusaurus-openapi-docs para converter o esquema OpenAPI resultante em arquivos MDX.

A execução do processo de geração de MDX requer deno .

O código-fonte desses auxiliares está em ./atproto-openapi-types/ .

Os arquivos brutos do Lexicon estão em atproto-openapi-types/lexicons/ , com um script auxiliar ( get-lexicons.sh ) que é executado automaticamente pelo Github CI todos os dias.

Para gerar novamente o arquivo OpenAPI:

 deno task run

Para gerar novamente todos os arquivos MDX do arquivo de esquema OpenAPI:

 npm run clear-and-gen-api-docs

Você pode testar se a saída é válida:

 npx docusaurus-mdx-checker

Então você normalmente verificaria se todo o site ainda pode ser compilado (isso é lento):

 # local dev server for preview
npm start

# or for a static build
npm run build

Licença do Documentos

O texto da documentação está sob Creative Commons Attribution (CC-BY).

Exemplos de código embutido, dados de exemplo e expressões regulares estão sob Creative Commons Zero (CC-0, também conhecido como Domínio Público) e copiados/colados sem atribuição.

Consulte LICENSE.txt com lembretes sobre trabalhos derivados e LICENSE-CC-BY.txt para obter uma cópia do texto legal da licença.