Руководство по установке
Это руководство описывает детальную установку и настройку окружения для работы с документацией Docs-as-Code Portfolio.
Требования к системе
| Компонент | Минимальная версия |
|---|---|
| Операционная система | Linux / macOS / Windows |
| Python | 3.9+ |
| pip | 21.0+ |
| Docker (опционально) | 20.0+ |
| Git | 2.30+ |
Установка зависимостей
Склонируйте репозиторий и установите зависимости:
git clone https://gitverse.ru/profdefence/docs-as-code-portfolio.git
cd docs-as-code-portfolio
pip install -r requirements.txt
Зависимости включают:
- mkdocs — статический генератор сайта.
- mkdocs-material — тема Material для MkDocs.
- mkdocs-minify-plugin — минификация HTML.
Проверка установки
Убедитесь, что MkDocs установлен корректно:
mkdocs --version
Вы должны увидеть версию MkDocs, например mkdocs, version 1.5.0.
Установка через Docker (альтернативный вариант)
Если вы предпочитаете изолированное окружение, используйте Docker:
docker build -t docs-portfolio .
Что дальше?
- Руководство по настройке — конфигурация системы.
- Руководство по интеграции — подключение внешних сервисов.
- Устранение неполадок — решение частых проблем.
- API Reference — документация REST API.
- Быстрый старт — быстрый способ начать работу.