summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md39
1 files changed, 37 insertions, 2 deletions
diff --git a/README.md b/README.md
index d7ae671..30772bb 100644
--- a/README.md
+++ b/README.md
@@ -48,7 +48,10 @@ do
git --work-tree="$CONTENT_DIR" checkout -f "$branch"
- make -C "$BASE_DIR" HUGO="$HUGO" CONTENT="$CONTENT_DIR" DEPLOY="$DEPLOY_DIR"
+ make -C "$BASE_DIR" HUGO="$HUGO" CONTENT="$CONTENT_DIR" DEPLOY="$DEPLOY_DIR" || {
+ echo "Build failed for branch $branch" >&2
+ exit 1
+ }
done
```
@@ -63,6 +66,25 @@ done
То есть на данный момент обновление сайта происходит простым push в ветку main.
+## Makefile structure
+
+В `landau_suite` используется Makefile со следующими основными переменными и целями:
+
+- `HUGO` – путь к исполняемому файлу Hugo (по умолчанию `hugo`).
+- `CONTENT` – директория с исходным контентом (например, `./content/main`).
+- `DEPLOY` – целевая директория для сгенерированного сайта (например, `./deploy/main`).
+
+Основная цель сборки (по умолчанию) выполняет:
+ - проверку наличия `HUGO` и `CONTENT`;
+ - вызов `hugo --source ... --destination ... --cleanDestinationDir ...`;
+ - опциональные пост-обработки (минификация, проверка ссылок).
+
+Для ручного запуска сборки вне хука:
+
+```bash
+make HUGO=/path/to/hugo CONTENT=/path/to/content DEPLOY=/path/to/deploy
+```
+
## Hugo
Сам hugo, одно жизненно важное исправление, которое позволяет держать contentDir отдельно от шаблона сайта (ветка nshubin/git_purism) остальные исправления комплиментарные:
@@ -80,4 +102,17 @@ $ ls -lah hugo
-rwxr-xr-x 1 maquefel users 53M May 17 08:13 hugo
$ file hugo
hugo: ELF 64-bit LSB executable, x86-64, version 1 (SYSV), statically linked, Go BuildID=u2UlnDikg6PiLZpmb49r/fzU1KYICg3ZTYqp8o1z3/CDiKIZ7CkmOcQoabnJdp/F3rP0MwJRD9ZxEV04ux1, stripped
-``` \ No newline at end of file
+```
+
+## Mermaid
+
+Есть условная поддержка mermaid. Hugo не умеет "рендерить" блоки mermaid в png/svg и автоматически вставлять их как картинки. Вся поддержка осуществляется внешним js скриптом. Тем не менее будет работать вот такое:
+
+```mermaid
+graph TD;
+ A-->B;
+ A-->C;
+ B-->D;
+```
+
+И другие mermaid диаграммы. \ No newline at end of file