create guide for mkdoks on docker-compose
This commit is contained in:
34
README.md
34
README.md
@@ -1 +1,33 @@
|
||||
# up-mkdocs-docker
|
||||
# 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
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user