agent-engineering/jellyfin-lessons
1
0
Fork 0
forked from sscoble/jellyfin-lessons
Code Pull requests Activity
Jellyfin plugin for homeschool lesson plans — Typst-based content with embedded media playback
3 commits 5 branches 0 tags 50 KiB
Find a file
Exact
Scott Scoble 0700c35310 feat: add Typst lesson template with Jellyfin media frontmatter 
- Add templates/lesson.typ: reusable template with lesson-template() function
  - Accepts title, grade, subject, date, media, description parameters
  - Comment-based frontmatter convention documented at top
  - Renders title heading, metadata line, description, body, media section
  - Media references use raw(lang: "jellyfin-media") for identifiable HTML elements
- Add templates/example-lesson.typ: complete example (Water Cycle lesson)
  - Demonstrates all template features
  - Christian-homeschool appropriate content (Psalm 135:7)
  - Includes 2 Jellyfin media references

Closes #3
2026-05-15 21:18:04 -07:00
templates feat: add Typst lesson template with Jellyfin media frontmatter 2026-05-15 21:18:04 -07:00
README.md Architecture and component overview 2026-05-15 21:12:08 -07:00

README.md

Jellyfin Lessons Plugin

A Jellyfin plugin that delivers homeschool lesson plans with embedded media playback. Content authored in Typst, managed via a web admin UI, displayed natively inside Jellyfin on any client (Fire TV, web, mobile).

Architecture

~/vault/lessons/                    ← Typst source files (author here)
    └── grade-N/
        └── subject/
            └── lesson-name.typ

        ↓ admin UI reads/writes lesson metadata

~/.local/share/jellyfin-lessons/    ← Lessons DB + compiled HTML cache
        ↓ Jellyfin plugin reads

Jellyfin "Lessons" tab              ← Plugin renders lesson HTML + media player

Components

  1. Jellyfin Plugin (C# / .NET 9) — Registers a "Lessons" page in Jellyfin, reads lesson data from the store, renders Typst-compiled HTML, and embeds the native Jellyfin media player for linked items.

  2. Lesson Data Store — SQLite database mapping lesson metadata (title, grade, subject, date, jellyfin item IDs) to compiled HTML output. Shared between the plugin and admin UI.

  3. Typst Lesson Template — A .typ template with frontmatter conventions for lesson metadata and embedded Jellyfin media references. Compiles to HTML.

  4. Web Admin UI — Simple web interface (served from n97) for creating, editing, and previewing lessons. Writes to the same SQLite store the plugin reads from.

  5. Nix Flake — Builds the plugin DLL, packages it for Jellyfin, provides a dev shell with dotnet-sdk + typst.

End State (Outcome Engineering)

  • Open Jellyfin on any device → see "Lessons" in the nav
  • Click a lesson → read the content → click play on embedded media → Jellyfin plays it
  • Author lessons by writing .typ files (with a web UI option)
  • Everything works fully offline on the homelab
  • One nix build produces the plugin

Development

nix develop    # dotnet-sdk, typst, node (for admin UI)

License

MIT