INTEGRITY Документация

← Cloudflare Workers / workers / framework-guides / web-apps / more-web-frameworks

Docusaurus

Начало из CLI: Создайте каркас проекта Docusaurus на Workers и выберите шаблон.

npm create cloudflare@latest -- my-docusaurus-app --framework=docusaurus

Или просто разверните: Создайте сайт документации на Docusaurus и разверните его в Cloudflare Workers: CI/CD и превью уже настроены за вас.

Развертывание в Workers

Что такое Docusaurus?

Docusaurus ↗ представляет собой фреймворк с открытым исходным кодом для создания, развёртывания и поддержки сайтов документации. Он построен на React и предлагает понятный способ создавать статические сайты, ориентированные на документацию.

Docusaurus разработан так, чтобы быть простым в использовании и настраиваемым, поэтому он стал популярным выбором среди разработчиков и организаций, которым нужно быстро создавать сайты документации.

Развертывание нового проекта Docusaurus на Workers

  1. Создайте новый проект с помощью create-cloudflare CLI (C3).

    npm create cloudflare@latest -- my-docusaurus-app --framework=docusaurus --platform=workers

    Что происходит за кулисами?

    Когда вы выполняете эту команду, C3 создаёт каталог нового проекта, инициализирует Официальный инструмент настройки Docusaurus ↗, и настраивает проект для Cloudflare. Затем предлагается возможность мгновенно развернуть ваше приложение в Cloudflare.

  2. Локальная разработка.

    После создания проекта выполните следующую команду в каталоге проекта, чтобы запустить локальный сервер разработки.

    npm run dev

  3. Разверните ваш проект.

    Ваш проект можно развернуть в поддомен *.workers.dev или Custom Domain, с локального компьютера или из любой системы CI/CD (включая Workers Builds).

    Используйте следующую команду для сборки и развёртывания проекта. Если вы используете CI-сервис, не забудьте соответствующим образом обновить "deploy command".

    npm run deploy

Развертывание существующего проекта Docusaurus на Workers

Если у вас статический сайт

Если ваш проект на Docusaurus полностью предварительно рендерится (а обычно так и есть), выполните следующие шаги:

  1. Добавьте файл конфигурации Wrangler.

    В корне проекта создайте файл конфигурации Wrangler со следующим содержимым:

    	{
		"name": "my-docusaurus-app",
		// Update to today's date
		// Set this to today's date
		"compatibility_date": "2026-08-28",
		"assets": {
			"directory": "./build"
		}
	}
    name = "my-docusaurus-app"
# Set this to today's date
compatibility_date = "2026-08-28"

[assets]
directory = "./build"

    Что делает эта конфигурация?

    Ключевой частью этой конфигурации является assets поле, которое указывает Wrangler, где искать статические ресурсы. В этом случае мы указываем Wrangler искать в ./build каталог. Если ваши ресурсы находятся в другом каталоге, обновите directory значение соответствующим образом. См. другие параметры конфигурации ресурсов.

    Также обратите внимание, что здесь нет main поле в этой конфигурации: это потому, что вы обслуживаете только статические ресурсы, поэтому код Worker для рендеринга по требованию или SSR не нужен.

  2. Создайте и разверните свой проект.

    Проект можно развернуть в *.workers.dev поддомен или пользовательский домен с локального компьютера или из любой системы CI/CD (включая Workers Builds). Используйте следующую команду для сборки и развёртывания. Если вы используете CI-сервис, обязательно обновите соответствующим образом свою команду "deploy command".

    npx docusaurus build
    npx wrangler@latest deploy

Используйте привязки с Docusaurus

Привязки представляют собой способ подключить проект Docusaurus к другим сервисам Cloudflare, позволяя хранить и получать данные в приложении.

Благодаря bindings ваше приложение можно полностью интегрировать с Cloudflare Developer Platform, получив доступ к вычислениям, хранилищу, AI и другим возможностям.

Bindings

Доступ к вычислениям, хранилищу, ИИ и другим возможностям.