Skip to content
ergonomic-codePublic

Latest commit

 

History

98 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Эргономичный подход

kb/ — база знаний в AsciiDoc, публикуемая как вики. Статьи сохраняют front matter и _index.adoc; ссылки между ними задаются относительными xref. Изображения находятся рядом со статьями.

wiki/content/ содержит главную страницу и служебные страницы сайта об авторе и о вики. Hugo mounts объединяют их с КБ, сохраняя прежние URL /docs/. Шаблон wiki/layouts/partials/kb-content.html разрешает относительные ссылки КБ через Hugo и переводит пути изображений в URL сайта. Он применяется только к документам из kb/.

wiki/ содержит конфигурацию Hugo, тему, шаблоны, статику и скрипты сайта. workbench/ — локальные рабочие материалы, исключённые из Git. Workflow публикации находится в .github/workflows/.

Разработка

Нужны Hugo extended 0.167.0 (версия CI), Ruby, Asciidoctor и Rouge.

hugo server --source wiki --disableFastRender --renderToMemory

После изменения статьи или изображения браузер обновляется автоматически. После удаления или переименования статьи перезапустите dev server: Hugo 0.140.0 может продолжать отдавать старый URL.

Проверка и публикация

hugo --source wiki --minify
python3 wiki/scripts/check_wiki.py wiki/public

Проверяются внутренние ссылки и изображения в статьях, наличие целевых файлов и якорей. GitHub Actions выполняет эту проверку перед публикацией; push в master обновляет GitHub Pages. История переносимых файлов доступна через git log --follow; дата последнего изменения Hugo включает коммит переноса.

Used by

Contributors

Languages