Universe

Create project in app

Персональный шаблон Typst для конспектов и заметок. Оформление рассчитано на печать: страница ISO B5, книжная типографика и единый акцентный RGB-цвет.

Начало работы

Установите Typst и Just, затем установите пакет локально в namespace preview. Это нужно, чтобы импорт в созданном документе @preview/sheaffer-notes находил локальную копию пакета:

just install-preview
typst init @preview/sheaffer-notes:0.1.0 my-notes

Стартовый документ находится в template/main.typ. Это конспект по теории пучков: предпучки, пучки, стебли, пучкование, окольцованные пространства и когомологии. В нём же показаны возможности шаблона: теоремы и доказательства, заметки на полях, списки, ссылки, сноски, таблицы, рисунки и блоки кода. Карта файлов и подробные инструкции по настройке находятся в CUSTOMIZATION.md.

Настройка оформления

  • Размер страницы и поля задаются в template/main.typ.
  • Акцентный цвет находится в src/_constants.typ в переменной ACCENT и задан в RGB. Измените его значение там, чтобы обновить акцент во всём шаблоне.
  • Шрифты, отступы и межстрочные интервалы также настраиваются в src/_constants.typ.

Для разработки библиотеки используйте just install (namespace local). Команда just thumbnail пересобирает изображения-превью; для неё нужны ImageMagick и optipng.

Публикация

Версия и сведения о пакете находятся в typst.toml. GitHub Actions workflow публикации по тегу v* собирает пакет и пушит ветку в репозиторий xegors/typst-packages; для этого нужен секрет REGISTRY_TOKEN. Из этой ветки открывается pull request в официальный репозиторий typst/packages, после слияния пакет становится доступен как @preview/sheaffer-notes.

Благодарности и лицензия

Sheaffer основан на шаблоне Mousse notes. Исходная лицензия и уведомление об авторстве сохранены в LICENSE.