nimbus README

README проекта с github.com/cloudflare/nimbus. Одним файлом markdown: README.md.

Nimbus

Nimbus is a documentation framework for Astro: docs for humans and agents, in your repo. It scaffolds the site into your repository, checks the content you and your agents write, and publishes it as HTML for people and Markdown for agents.

Docs: nimbus-docs.com

Quickstart

Requires Node.js 22.23.4 or later.

npx @cloudflare/create-nimbus-docs@latest my-docs --yes --package-manager npm
cd my-docs
npm run dev

Pages live in src/content/docs/ as MDX or Markdown. Start with src/content/docs/index.mdx, and set the site's URL, title and description in astro.config.ts; they ship as placeholders.

How it works

Features

Writing:

Checking:

Publishing for agents:

Deploy

Sites are static by default: npm run build, then host the output anywhere. Rendering pages on request and the remote MCP server need a server adapter (Cloudflare, Netlify, Vercel or Node); see Deploy.

Packages

Package What it is
@cloudflare/create-nimbus-docs Creates a new site.
@cloudflare/nimbus-docs The Astro integration and the nimbus-docs CLI.

Status

Pre-1.0. The public API can change between minor releases. Pin your versions and read each package's changelog (nimbus-docs, create-nimbus-docs) before upgrading. Upgrade a Nimbus site walks through one.

Contributing

Pull requests are welcome; for anything bigger than a small fix, start with an issue or a discussion. See CONTRIBUTING.md, and CLAUDE.md for the architecture and agent context.

License

MIT

nimbus (cloudflare/nimbus)

Ищем в базе…

1.8K ·GitHub
Что это такое?Nimbus — это инструмент для написания документации, построенный на Astro. Он создаёт сайт с документацией внутри вашего репозитория, проверяет то, что пишете вы и ваши агенты, и публикует HTML для людей и Markdown для агентов.
Это библиотека или готовый сайт документации?И то и другое: скаффолдер копирует код сайта (макеты, компоненты, маршруты, контент) в ваш репозиторий, где его можно редактировать, а пакет @cloudflare/nimbus-docs предоставляет интеграцию с Astro, вспомогательные функции и CLI.
Как это запустить?Нужен Node.js 22.12.0 или новее. Создайте сайт с помощью пакета @cloudflare/create-nimbus-docs, пишите страницы в src/content/docs/ в формате MDX или Markdown, начиная с index.mdx, а адрес сайта, заголовок и описание задайте в astro.config.ts, где они по умолчанию стоят как заглушки.
Можно ли на это полагаться?Версия пока до 1.0, поэтому публичный API может меняться между минорными релизами. Зафиксируйте версии и перед каждым обновлением читайте журналы изменений nimbus-docs и create-nimbus-docs.
Обязательно ли размещать его на Cloudflare?Нет. Статические сборки можно разместить где угодно. Cloudflare, Netlify, Vercel и Node нужны только для рендеринга по запросу и удалённого MCP-сервера.
Может ли он загружать документацию из других источников?Да. Поддерживаются версии документации и поиск, а также загрузка страниц из других Git-репозиториев или из Notion.
Какие компоненты MDX есть из коробки?Блоки кода, вкладки, шаги, карточки, деревья файлов, повторно используемые фрагменты и интерактивные диаграммы. Некоторые из них устанавливаются по требованию командой nimbus-docs add.
Останавливает ли предупреждение линтера сборку?Нет. nimbus-docs lint сообщает об ошибках оформления по правилам из astro.config.ts, но не блокирует сборку.
Какие есть похожие проекты?redoc, buildawesome, openwiki, mdBook, docusaurus, vibex, fumadocs, context7
Автор
cloudflare
Размер
15.1 MB
Звёзды
1.8K
Возраст
4 мес
Коммиты · 90 дней