← Cloudflare Pages / pages / framework-guides

MkDocs

MkDocs ↗ это современная платформа документации, где команды могут документировать продукты, внутренние базы знаний и API.

Для работы MkDocs требуется актуальная версия Python и менеджер пакетов pip, установленные в вашей системе. Инструкции по установке pip см. в Руководство по установке MkDocs ↗. После установки pip выполните:

pip install mkdocs

Используйте mkdocs new для создания нового приложения:

mkdocs new <PROJECT_NAME>

Затем cd в ваш проект, возьмите MkDocs и его зависимости и поместите их в requirements.txt файле:

pip freeze > requirements.txt

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

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

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

Создайте новый репозиторий 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

Вы успешно создали репозиторий GitHub и отправили в него проект MkDocs.

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

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

   Перейдите в Workers & Pages ↗

2. Выберите Создать приложение.

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

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

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

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

7. Перейдите в Переменные окружения (расширенные) > Добавить переменную > и добавьте переменную PYTHON_VERSION со значением 3.7.

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

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

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

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