📝🎓 Academic-AI: Typst шаблон для написания отчетов/дипломов/курсовых работ(ИИ совместимый)

Готовый шаблон, который оформлен по требованиям РТУ МИРЭА

📦 Установка Typst

Для работы с шаблоном вам понадобится Typst.

🪟 Windows

Установка на Windows

Выполните команду в PowerShell или CMD:

winget install --id Typst.Typst

🐧 Linux

Установка на Linux

Выполните команду в терминале:

curl -fsSL https://typst.community/typst-install/install.sh | sh

🍎 macOS

Установка на macOS

Выполните команду в терминале:

brew install typst

✍️ Написание работы

Работу можно написать двумя способами: вручную или с помощью ИИ-ассистента.

Вариант 1: Вручную

Если вы предпочитаете писать самостоятельно:

1. Изучите документацию:

   • Документация по шаблону ГОСТ — подробная инструкция по использованию макросов, вставке таблиц, рисунков и формул.
   • Официальная документация Typst — полный справочник по синтаксису.

2. Отредактируйте необходимые файлы:

   • chapters/02_main_text.typ — основной текст работы
   • chapters/03_references.typ — список литературы
   • chapters/04_appendix.typ — приложения (если нужны)
   • Добавьте изображения в assets/images/
   • Добавьте код в assets/codes/

3. Замените титульный лист:

   • Если у вас есть готовый титульный лист — замените файл assets/title_page.pdf
   • Если титульный лист не нужен — просто удалите файл

Вариант 2: С помощью ИИ

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

Доступные скиллы:

• format-typst-gost — форматирование по ГОСТу (таблицы, формулы, рисунки, списки литературы и т.д.)
• write-human-academic-text — написание "человеческого" академического текста
• gost-text-rules — проверка и соблюдение правил ГОСТ при написании текста (пунктуация, кавычки, сокращения, оформление списков и ссылок)
• humanize-academic-text — "очеловечивание" уже написанного текста

---

📁 Структура проекта

Academic-AI/
├── AGENTS.md                  # Координатор для ИИ-агентов
├── main.typ                   # Главный файл (точка входа)
├── main.pdf                   # Скомпилированный PDF
├── chapters/
│   ├── 01_toc.typ             # Содержание (автогенерация)
│   ├── 02_main_text.typ       # Основной текст работы
│   ├── 03_references.typ      # Список литературы
│   └── 04_appendix.typ        # Приложения
├── settings/
│   ├── gost_core.typ          # Основные настройки ГОСТ
│   ├── gost_tables.typ        # Макросы для таблиц
│   ├── gost_figures.typ       # Макросы для рисунков
│   ├── gost_math.typ          # Макросы для формул
│   ├── gost_listings.typ      # Макросы для листингов кода
│   ├── gost_references.typ    # Макросы для списка литературы
│   └── gost_appendix.typ      # Макросы для приложений
├── assets/
│   ├── title_page.pdf         # Титульный лист
│   ├── images/                # Изображения для работы
│   └── codes/                 # Файлы с кодом
└── .agents/skills/            # Скиллы для ИИ-агента

---

🚀 Быстрый старт

1. Установите Typst (см. раздел Установка)

2. (Опционально) Для удобной работы с проектом, установите Vs code и расширение Tinymist Typst

3. Склонируйте/скопируйте шаблон:

   git clone https://github.com/xEncerx/Academic-AI
   cd Academic-AI

4. Начните писать!

   • Вручную — редактируйте файлы в chapters/
   • Или вызовите ИИ-агента и описывайте, что нужно добавить

5. Скомпилируйте PDF:

   typst compile main.typ main.pdf

🔄 Обновление шаблона

Обновляются только файлы шаблона (settings/, main.typ, .agents/ и т.д.). Ваши файлы в chapters/ и assets/ не затрагиваются.

🐧 Linux / 🍎 macOS

chmod +x update.sh && ./update.sh

🪟 Windows

.\update.ps1

📄 Лицензия

Свободное использование и распространение. Делайте, что хотите ❤️