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 +```