2.4 KiB
2.4 KiB
Документация пользователя Scientia
Этот каталог содержит только материалы для авторов документов. Для работы с ним не нужно знать внутреннюю архитектуру Typst-шаблона.
Рекомендуемый порядок
- Пройдите первый запуск и настройку VS Code.
- Выберите вид документа по инструкции Работа с документами.
- Откройте каталог приёмов оформления и копируйте подходящие примеры.
- Перед совместной работой прочитайте Git для авторов.
- Для финального выпуска подключите приватные подписи и печати.
Навигация
| Документ | Содержание |
|---|---|
| documents.md | Один main.typ, режимы, виды документов, главы и ресурсы |
| formatting.md | Рисунки, таблицы, формулы, ссылки, CSV и списки |
| examples/README.md | Компилируемые примеры отчёта, письма, ТКП, договора и оформления |
| vscode.md | Расширения, предпросмотр, автосохранение и задачи |
| git.md | Commit, branch, pull, push, merge и конфликты простыми словами |
| private-assets.md | Папка .private, подписи сотрудников и индивидуальные смещения |
| writing-style.md | Заготовка запроса для редактирования технического текста |
| troubleshooting.md | Решение типовых ошибок |
Где находится разработка шаблона
Архитектура, ADR, тесты, snapshots и заметки сопровождающих находятся в .template/development/. Обычному автору открывать этот каталог не требуется.