bsky docs

docs.bsky.app

Этот репозиторий содержит исходный код веб-сайта документации для разработчиков Bluesky: https://docs.bsky.app.

Этот сайт включает учебные пособия, блог, руководства и справочную документацию по HTTP API для приложения Bluesky.

Документация и спецификации протокола AT представляют собой отдельный веб-сайт (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/ .

Необработанные файлы 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 для получения копии юридического текста лицензии.