186 lines
7.5 KiB
Markdown
186 lines
7.5 KiB
Markdown
# Настройки взаимодействия
|
||
|
||
## Общие принципы работы
|
||
|
||
1. Все важные решения и изменения фиксируются в README.md
|
||
2. Взаимодействие происходит на русском языке
|
||
3. Перед применением изменений проверяется корректность принятых решений
|
||
4. Цель — максимально быстро запустить проект для публикации контента
|
||
|
||
## Описание проекта
|
||
|
||
**dedinit.ru** — блог на основе генератора статических сайтов Hugo с кастомной темой **rDedInit** (форк PaperMod).
|
||
|
||
**Основная цель:** платформа для публикации лонгридов с поддержкой блоков кода и подсветки синтаксиса.
|
||
|
||
### Технические характеристики
|
||
|
||
| Параметр | Значение |
|
||
|----------|----------|
|
||
| Генератор | Hugo Extended 0.155.1 |
|
||
| Тема | rDedInit (форк PaperMod) |
|
||
| Язык | Русский (ru-ru) |
|
||
| Формат статей | Bundle (папка с index.md) |
|
||
| Деплой | SFTP (kpa39l.myjino.ru:2222) |
|
||
|
||
### Структура проекта
|
||
|
||
```
|
||
dedinit.ru/
|
||
├── content/
|
||
│ ├── posts/ # Статьи блога (bundle формат)
|
||
│ └── telegram/ # Telegram-посты (планируется)
|
||
├── themes/
|
||
│ └── rDedInit/ # Кастомная тема на базе PaperMod
|
||
├── static/
|
||
│ └── images/
|
||
│ └── favicon/ # Favicon в стиле пиксель-арт (SmileDed)
|
||
├── public/ # Сгенерированный сайт (исключён из git)
|
||
├── layouts/ # Кастомные шаблоны (если есть)
|
||
├── assets/ # CSS/JS ресурсы
|
||
├── hugo.toml # Конфигурация Hugo
|
||
├── Makefile # Команды сборки и деплоя
|
||
└── docs/ # Документация
|
||
```
|
||
|
||
## Проверочные действия
|
||
|
||
Перед выполнением каждого этапа выполняются проверки:
|
||
- Наличие установленного Hugo (`hugo version`)
|
||
- Возможность сборки сайта (`hugo`)
|
||
- Корректность настроек темы (проверка `hugo.toml`)
|
||
- Работоспособность деплоя (`make deploy-dry-run`)
|
||
|
||
## Команды проекта
|
||
|
||
### Сборка и запуск
|
||
|
||
```bash
|
||
hugo # Генерация сайта в public/
|
||
hugo server # Локальный сервер (http://localhost:1313)
|
||
make build # Сборка через Makefile
|
||
make clean # Очистка public/
|
||
make rebuild # Полная пересборка
|
||
```
|
||
|
||
### Деплой
|
||
|
||
```bash
|
||
make deploy # Сборка + деплой на хостинг
|
||
make deploy-dry-run # Симуляция деплоя
|
||
make help # Список доступных команд
|
||
```
|
||
|
||
### Параметры деплоя
|
||
|
||
| Параметр | Значение |
|
||
|----------|----------|
|
||
| Хост | kpa39l.myjino.ru |
|
||
| Порт SFTP | 2222 |
|
||
| Пользователь | kpa39l_dedinit |
|
||
| Путь | /dedinit.ru |
|
||
|
||
## Принятые технические решения
|
||
|
||
1. **Структура проекта**: Git-репозиторий инициализирован в папке с Hugo-сайтом
|
||
2. **Формат статей**: Bundle (папка с index.md) для удобного хранения статьи и связанных файлов
|
||
3. **Тема rDedInit**: Собственная тема на базе PaperMod с русификацией
|
||
4. **Деплой**: Кроссплатформенный (rsync для Unix, WinSCP для Windows)
|
||
5. **Favicon**: Набор в стиле пиксель-арт (SmileDed) с логотипом 48px в шапке
|
||
6. **Подсветка кода**: github-dark стиль с номерами строк
|
||
|
||
## Конфигурация темы (hugo.toml)
|
||
|
||
### Основные параметры
|
||
|
||
```toml
|
||
baseURL = 'https://dedinit.ru/'
|
||
title = 'dedinit()'
|
||
theme = 'rDedInit'
|
||
timeZone = 'Europe/Moscow'
|
||
metaDataFormat = "yaml"
|
||
```
|
||
|
||
### Параметры PaperMod
|
||
|
||
```toml
|
||
[params]
|
||
env = "production"
|
||
defaultTheme = "auto"
|
||
ShowReadingTime = true
|
||
ShowPostNavLinks = true
|
||
ShowBreadCrumbs = true
|
||
ShowCodeCopyButtons = true
|
||
disableSpecial1stPost = true
|
||
|
||
[markup.highlight]
|
||
style = "github-dark"
|
||
lineNos = true
|
||
tabWidth = 4
|
||
```
|
||
|
||
## Дорожная карта (ROADMAP)
|
||
|
||
### Завершённые задачи ✅
|
||
|
||
- [x] Установка Hugo Extended 0.155.1
|
||
- [x] Создание сайта dedinit.ru
|
||
- [x] Установка темы PaperMod (submodule)
|
||
- [x] Создание собственной темы rDedInit
|
||
- [x] Настройка bundle формата статей
|
||
- [x] Настройка favicon и логотипа (SmileDed)
|
||
- [x] SFTP-деплой на kpa39l.myjino.ru
|
||
- [x] Написание первых статей (6 публикаций)
|
||
|
||
### Текущие задачи 🎯
|
||
|
||
- [ ] Настройка цветовой схемы темы
|
||
- [ ] Русификация интерфейса (i18n/ru.yaml)
|
||
- [ ] Визуальное оформление Telegram-постов
|
||
- [ ] Публикация новых статей
|
||
|
||
### Планы 📈
|
||
|
||
- [ ] SEO оптимизация (Open Graph, sitemap)
|
||
- [ ] Аналитика (Google Analytics/Яндекс.Метрика)
|
||
- [ ] Поиск по сайту (Fuse.js)
|
||
- [ ] Комментарии (Giscus/Utterances)
|
||
|
||
## Примечания
|
||
|
||
- Важно обеспечить поддержку блоков кода и подсветки синтаксиса
|
||
- Проект должен быть готов к публикации контента как можно скорее
|
||
- Папка `public/` исключена из git-репозитория
|
||
- Для обновления Hugo: `winget install Hugo.Hugo.Extended`
|
||
|
||
## Информация о системе
|
||
|
||
- ОС: Windows 11
|
||
- Hugo установлена через winget
|
||
- Требуется перезапуск терминала после установки/обновления Hugo
|
||
- Текущая версия Hugo: 0.155.1
|
||
|
||
## Полезные ссылки
|
||
|
||
- [Документация PaperMod](https://github.com/adityatelange/hugo-PaperMod/wiki)
|
||
- [Документация Hugo](https://gohugo.io/documentation/)
|
||
- [PAPERMOD_PARAMS.md](PAPERMOD_PARAMS.md) — полный справочник параметров темы
|
||
- [ROADMAP.md](ROADMAP.md) — дорожная карта проекта
|
||
- [DEPLOY_INSTRUCTIONS.md](DEPLOY_INSTRUCTIONS.md) — инструкция по деплою
|
||
|
||
## Файлы документации
|
||
|
||
| Файл | Описание |
|
||
|------|----------|
|
||
| README.md | Основное описание проекта |
|
||
| ROADMAP.md | Дорожная карта развития |
|
||
| PAPERMOD_PARAMS.md | Справочник параметров темы |
|
||
| DEPLOY_INSTRUCTIONS.md | Инструкция по деплою |
|
||
| gitea-setup.md | Настройка интеграции с Gitea |
|
||
| docs/favicon-logo-setup.md | Настройка favicon и логотипа |
|
||
| Telegram_frontend.md | Оформление Telegram-постов |
|
||
|
||
---
|
||
|
||
**Последнее обновление:** 5 марта 2026 г.
|