Skip to content

DaniilGavrin/git-guide

Repository files navigation

📘 Git Guide: Полное руководство и шпаргалка

GitHub release GitHub pages License

Ваш универсальный справочник по Git: от первых шагов до продвинутых техник управления версиями. Идеально подходит для новичков, разработчиков и команд, желающих систематизировать знания.

🚀 О проекте

Этот репозиторий содержит исчерпывающую документацию по системе контроля версий Git. Здесь собраны все необходимые команды, примеры использования, лучшие практики и стратегии работы с ветками.

Главная цель — предоставить ресурс, которым можно пользоваться ежедневно:

  • 🌐 Онлайн-версия: Удобный сайт с поиском и навигацией.
  • 🖨️ PDF-шпаргалка: Готовый файл для печати, содержащий все команды в одном месте.
  • 📚 Структурированные гайды: От установки до решения сложных конфликтов.

🔗 Быстрые ссылки

Ресурс Описание
🌍 Открыть сайт документации Полная интерактивная версия руководства
⬇️ Скачать PDF (v1.0.0) Версия для печати (A4, шрифт Arial)
📂 Исходный код Markdown файлы документации

📖 Что внутри?

Документация разбита на логические блоки для удобного изучения:

🟢 Для новичков

  • Установка и настройка: Конфигурация имени, email, алиасов.
  • Основы работы: init, add, commit, status, log.
  • Работа с удаленными репо: clone, push, pull, fetch.

🟡 Для уверенных пользователей

  • Ветвление: Создание, переключение, слияние (merge).
  • Откат изменений: reset, restore, revert, stash.
  • Решение конфликтов: Пошаговые инструкции при слиянии.

🔴 Для профи

  • Продвинутые техники: rebase, cherry-pick, reflog.
  • Инструменты: Поиск по истории, диффы, теги.
  • Автоматизация: Git Hooks и подмодули.
  • Стратегии: Git Flow, GitHub Flow, Trunk Based Development.

🖨️ Печатная версия (Cheatsheet)

Мы подготовили специальный файл git-commands-full.pdf, который содержит абсолютно все команды в структурированном виде.

  • Формат: A4, оптимизировано для печати.
  • Шрифт: Arial (заголовки 12pt, текст 10pt).
  • Структура: Команды сгруппированы по задачам для мгновенного поиска.

👉 Скачать последнюю версию можно в разделе Releases.

🛠 Как использовать этот репозиторий

1. Просмотр онлайн

Просто перейдите на сайт документации, созданный через MkDocs. Сайт автоматически обновляется при пуше в ветку main.

2. Локальная разработка документации

Если вы хотите дополнить гайд:

# Клонирование
git clone https://github.com/DaniilGavrin/git-guide.git
cd git-guide

# Установка зависимостей (требуется Python)
pip install mkdocs mkdocs-material

# Запуск локального сервера
mkdocs serve

Откройте http://127.0.0.1:8000 в браузере.

3. Печать шпаргалки

Скачайте PDF из релизов или сгенерируйте его самостоятельно из файла to-print/git-commands-full.md.

🤝 Вклад в проект

Мы приветствуем улучшения! Если вы нашли ошибку, неточность или хотите добавить новый раздел:

  1. Создайте форк репозитория.
  2. Создайте ветку feature/my-improvement.
  3. Внесите изменения в папку docs/.
  4. Отправьте Pull Request.

📄 Лицензия

Материалы распространяются под лицензией MIT. Используйте знания во благо!


Создано с ❤️ для сообщества разработчиков.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Packages

 
 
 

Contributors