vkr-build 0.1.2

Автоматизированное решение вёрстки курсовых/дипломных работ.

vkr-build

Автоматизированное решение вёрстки курсовых/дипломных работ в соответствие с ГОСТом на базе движка WeasyPrint. Позволяет сосредоточиться на содержании, а не на деталях оформления.

Особенности

• Markdown или HTML в качестве языка разметки;
• Поддержка многофайловой структуры проекта;
• Простая кастомизация;
• Работает "из коробки" на большинстве платформ;

Примеры работ

• Комплексный пример со всеми возможностями (PDF)
• Реальный ВКР по юриспруденции (PDF)

Поддержка

Сквозной нумерации всех фигур (рисунков, таблиц), заголовков до третьего уровня, приложений. Генерация оглавления.

Поддерживаемые элементы:

• Заголовки
• Списки
• Блоки кода
• Сноски
  • inline html
  • markdown сноски
• Фигуры
  • Рисунки
  • Таблицы
• Цитаты

Установка

Зависимости

• Python 3.12+
• pandoc

pip install --upgrade vkr-build

Собранные пакеты можно также найти на странице релизов.

Использование

Конфигурационный файл

# document.toml

files = [
  # Последовательность файлов
]

# Путь до скомпилированного PDF-файла
output = 'output.pdf'

# Путь до пользовательских стилей
css = 'custom.css' 

# Префикс для названия глав
chapter_prefix = 'Глава '

# Заголовок для оглавления 
toc_title = 'Оглавление'

Переменные CSS

:root {
  /* Начала подсчёта страниц, включая заголовок. */
  --start-page: 2;

  /* Расположение подзаголовков. */
  --subheader-align: center;

  /* https://developer.mozilla.org/en-US/docs/Web/CSS/list-style-type */

  /* Шрифт кода. */
  --font-mono: monospace;

   /* Режим переноса фигур (рис, таблиц). По-умолчанию, если они не помещаются
      на страницу, то переходят на новую. */
  --figure-break-inside: avoid;
}

Markdown

Сноски.

Приятно, граждане<footnote>Тут находится inline-сноска.</footnote>, наблюдать, 
как тщательные исследования конкурентов функционально разнесены на независимые элементы.

Для разработчика

To-Do

• По хорошему заменить pandoc на что-то нативное, но это сложно (нужен pandoc-like markdown конвертор)
• Добавить больше стилей