Skip to content

Алгоритм публикации на GitHub Pages

1. Настройка репозитория

  • Инициализируйте Git-репозиторий, если этого ещё не сделали:
git init
git add .
git commit -m "Первый коммит"
git branch -M main
git remote add origin https://github.com/ваш_пользователь/ваш_репозиторий.git
git push -u origin main

2. Настройка GitHub Pages

В настройках вашего репозитория на GitHub выберите GitHub Pages из ветки gh-pages (мы настроим это позже).

3. Добавление скрипта развертывания

Создайте файл deploy.sh в корневой директории:

#!/bin/bash

# Сборка проекта
mkdocs build

# Развертывание на ветку gh-pages
mkdocs gh-deploy --force
Сделайте скрипт исполняемым(macos linux):

chmod +x deploy.sh

4. Автоматизация с помощью GitHub Actions

Создайте каталог .github/workflows/ и файл deploy.yml:

name: Deploy MkDocs to GitHub Pages

on:
  push:
    branches: [ main ]

jobs:
  build-deploy:
    runs-on: ubuntu-latest

    steps:
      - name: Check out the repo
        uses: actions/checkout@v2

      - name: Set up Python
        uses: actions/setup-python@v2
        with:
          python-version: '3.x'

      - name: Install dependencies
        run: |
          pip install mkdocs
          pip install mkdocs-material

      - name: Build and Deploy
        run: |
          mkdocs gh-deploy --force
Теперь при каждом пуше в ветку main ваш сайт будет автоматически собираться и публиковаться на GitHub Pages.

Git Команды

  • Проверка статуса репозитория:
git status
  • Добавление файлов:

    git add .
    
  • Коммит изменений:

    git commit -m "Сообщение коммита"
    

  • Коммитите и пушите изменения:

    git add .
    git commit -m "Setup GitHub Actions"
    git push
    

Очистите кэш GitHub Pages:

Иногда GitHub Pages кэширует старые версии страниц. Попробуйте добавить параметр ?cache_bust=1 к URL вашей страницы, чтобы обойти кэш.