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

Docusaurus

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

Настройка нового проекта

Используйте create-cloudflare CLI (C3) для настройки вашего проекта. C3 создаст каталог нового проекта, запустит официальный инструмент настройки Docusaurus и предложит возможность мгновенного развертывания.

Чтобы использовать create-cloudflare чтобы создать новый проект Docusaurus, выполните следующую команду:

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

create-cloudflare установит дополнительные зависимости, включая Wrangler CLI и все необходимые адаптеры, а затем задаст вопросы по настройке.

Прежде чем продолжить

Все руководства по фреймворкам предполагают, что у вас уже есть базовое понимание Git. Если вы новичок в Git, обратитесь к этому краткое руководство по Git о том, как настроить Git на локальном компьютере.

Если вы клонируете по SSH, необходимо сгенерировать ключи SSH на каждом компьютере, с которого вы отправляете или получаете данные из GitHub.

См. документация GitHub и Документация Git, где это описано подробнее.

Создайте репозиторий GitHub

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

git init
git remote add origin https://github.com/<your-gh-username>/<repository-name>
git add .
git commit -m "Initial commit"
git branch -M main
git push -u origin main

Развернуть с помощью Cloudflare Pages

Развернуть через create-cloudflare CLI (C3)

Если вы используете create-cloudflare(C3) чтобы создать новый проект Docusaurus: C3 установит все зависимости, необходимые проекту, и предложит развернуть его через CLI. Если вы согласитесь, сайт станет доступен в сети, и вы получите URL-адрес развертывания.

Развернуть через панель управления Cloudflare

Чтобы развернуть сайт в Pages:

  1. На панели управления Cloudflare перейдите к разделу Workers & Pages страницу.

    Перейдите в Workers & Pages ↗
  2. Выберите Создать приложение.

  3. Выберите Pages на вкладке.

  4. Выберите Импорт существующего репозитория Git.

  5. Выберите созданный вами новый репозиторий GitHub, а затем нажмите Начало настройки.

  6. В Настройки сборки разделе выберите Docusaurus как ваш Framework preset. Ваш выбор предоставит следующую информацию:

Параметр конфигурацииЗначение
Продакшен-веткаmain
Команда сборкиnpm run build
Директория сборкиbuild

После деплоя сайта вы получите уникальный поддомен для своего проекта на *.pages.dev.

Каждый раз, когда вы фиксируете новый код в своём сайте на Docusaurus и отправляете эти изменения в GitHub, Cloudflare Pages автоматически пересоберёт и развернёт ваш проект. Вы также получите доступ к развёртывания предпросмотра для новых pull request, и вы сможете увидеть, как изменения выглядят на сайте, прежде чем разворачивать их в продакшен.

Полное руководство по развёртыванию первого сайта на Cloudflare Pages см. в Руководство по началу работы.

Подробнее

После выполнения этого руководства вы успешно развернули свой сайт на Docusaurus на Cloudflare Pages. Чтобы начать работу с другими фреймворками, обратитесь к списку руководств по фреймворкам.