From 9904c7af091826d53f7724eee427f86067714c23 Mon Sep 17 00:00:00 2001 From: admin1350 <147304099+admin1350@users.noreply.github.com> Date: Tue, 24 Feb 2026 23:45:03 +0300 Subject: [PATCH] create guide for mkdoks on docker-compose --- README.md | 34 +++++++++++++++++++++++++++++++++- 1 file changed, 33 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index ed0612d..a7980e8 100644 --- a/README.md +++ b/README.md @@ -1 +1,33 @@ -# up-mkdocs-docker \ No newline at end of file +# up-mkdocs-docker +#### 1. Создай docker-compose.yml +В корне проекта создай файл со следующим содержимым: +```yaml +version: '3.8' + +services: + mkdocs: + image: squidfunk/mkdocs-material # Самый популярный и красивый движок + ports: + - "8000:8000" + volumes: + - .:/docs + command: serve -a 0.0.0.0:8000 +``` + +#### 2. Подготовь структуру +Если у тебя ещё нет контента, создай папку docs и файл настроек: + +- Папка `docs/` — здесь лежат твои `.md` файлы (создай там `index.md`). +- Файл `mkdocs.yml` в корне: + +```yaml +site_name: My Awesome Docs +theme: material +``` + +#### 3. Запуск +Просто пропиши в терминале: + +```bash +docker compose up -d +```