Skip to content

Структура репозитория

Anton Angelgardt edited this page Oct 18, 2024 · 6 revisions

wlm-sdarp

  • archive — хранилище старых версий и прошлых наработок
  • bookдиректория книги
  • data — хранилище датасетов, используемых при разработке книги
  • deploy — скрипты, с помощью которых выполняется деплой книги на GitHub Pages
  • dev —  скрипты, используемые в процессе разработки материалов
  • docs — директория, из которой GitHub Pages строит сайт
  • drafts — файлы черновиков кода, глав, тестовых файлов и др.
  • manim — Python-скрипты для создания видеоматериалов с помощью библиотеки Manim
  • shinyShiny-приложения, написанные для книги
  • other — разное неклассифицированное
  • README.md, LICENSE.md, .gitignore со стандартным содержанием

book

  • Директория с материалами книги является проектом Quarto Book
    • book.Rproj — файл проекта
  • Контент книги делится на части, страницы-«обложки» которых начинаются с префикса part-:
    • part-r.qmd — R
    • part-math.qmd — Математика для анализа данных
    • part-measures.qmd — Теория измерений
    • part-desc.qmd — Описательная статистика
    • part-prob.qmd — Теория вероятности и математическая статистика
    • part-andan.qmd — Методы анализа данных
  • Главы книги названы по шаблоны <part-name>_<chapter-name>.qmd
  • Названия страниц приложений начинаются с префикса appendix-
  • common_<...>.qmd — ненумерованные главы, не относящиеся к какой-либо части книги
  • index.qmd — домашняя страница книги
  • references.qmd и references.bib — список использованной литературы
  • _quarto.yml, _metadata.yml и _lang.yml — мета-файлы проекта
  • img — картинки
    • Для каждой главы автоматически создается (при запуске скрипта dev/new/run.sh) отдельная папка, чтобы было удобнее ориентироваться. Название папки совпадает в названием главы.
    • labs — лейблы для глав/разделов/подразделов и заданий квизов и листков
    • other — другие визуалиации, используемые для оформления (обложка, баннер, favicon)
    • debug — картинки, использованные при дебаге стилей
  • tbl — таблицы (файлы .tgn), созданные с помощью Table Generator
    • Для каждой главы автоматически создается (при запуске скрипта dev/new/run.sh) отдельная папка, чтобы было удобнее ориентироваться. Название папки совпадает в названием главы.
  • style — стилевые файлы
    • css — SCSS/CSS-файлы
    • fonts — файлы шрифтов
    • theme — файлы стилей оформления кода
    • refs — файлы стилей ссылок на источники
  • js — кастомные JS-скрипты
  • other — другие служебные файлы

docs

  • cr — текущий релиз книги (current release)
  • dpl — последняя деплойнутая версия книги для вычитки и отладки (deploy)
  • prev — предыдущие релизы книги (previous release)
  • index.html — перенаправление на текущий релиз при обращении к URL книги

deploy

  • run.sh — основной файл деплоя
  • modules — модули деплоя
  • backup — бэкап предыдущего деплоя
  • logs — логи рендеринга, деплоя и релиза

dev

  • run — директория с исполняемыми файлами, используемыми в ходе разработки
  • _quiz — файлы/скрипты, необходимые для верстки квизов
  • _sheet — файлы/скрипты, необходимые для верстки листков
  • _templates — шаблоны квизов, листков, глав, страниц-обложен частей и др.