Schema and Golden-Deck for Taleem (UI-agnostic)
npm install taleem-coretaleem-coreStatus: Stable
API Version: 1.5.1
Deck Schema: deck-v1 (frozen)
taleem-core is part of the Taleem project.
Taleem is a system that converts Taleem JSON into clean educational slides.
👉 Demo & docs:
https://bilza2023.github.io/taleem/
---
taleem-core contains only the permanent foundations of Taleem:
1. The schema that defines what a valid Taleem slide deck looks like
2. One golden reference deck that represents the slide language
That’s it.
This package answers just one question:
> Is this Taleem JSON valid or not?
---
taleem-core does not:
- render slides
- play slides
- animate slides
- deal with time, audio, UI, or browsers
- show anything on screen
If something runs, draws, or plays — it does not belong here.
---
Probably not.
Most users will:
- use the Taleem demo
- use a player or browser built on top of Taleem
- never touch taleem-core directly
This package exists mainly for:
- internal correctness
- validation
- documentation of the slide language
If you’re curious, you can read it.
---
taleem-core provides:
- a Zod schema for Taleem decks
- definitions for all declared slide types
- a single golden deck that validates successfully
If the golden deck passes validation, the schema is correct.
---
taleem-core@1.x exposes a small, stable, frozen API.
These exports are guaranteed not to break within deck-v1.
``js``
import { zodDeckV1 } from "taleem-core";
The canonical Zod schema that defines a valid Taleem deck.
---
`js`
import { validateDeckV1 } from "taleem-core";
Validates a deck against deck-v1.
Returns a success result or detailed validation errors.
---
`js`
import { goldenDeckV1 } from "taleem-core";
A complete, valid reference deck that represents the Taleem slide language.
If this deck validates successfully, the schema is correct.
---
taleem-core defines a finite, stable slide language.
These slide type names are part of the public contract and will not change within deck-v1:
* titleSlide
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
These layouts represent core presentation primitives.
Players and browsers decide how (or whether) to render them.
---
The eq slide type is declared but not supported in v1 players.
It exists to reserve the name and schema space for future versions, but:
* it is not rendered in current Taleem players
* it should not be generated or used in production decks
* no math engine (KaTeX / MathJax) is included in v1
Treat eq as intentionally inactive in deck-v1.
Support for equations and math slides may be introduced in a future version
or as a separate product.
---
The golden deck is the reference example of Taleem.
* It uses all actively supported slide types
* It follows the schema correctly
* It represents the intended slide language
If something breaks in a browser or player but this deck is valid:
> the problem is not in taleem-core
---
Think of taleem-core like this:
> **It defines the language.
> Other projects decide how to speak it.**
---
Only change taleem-core if:
* the schema itself is wrong
* a rule is clearly incorrect
* a new deck version is intentionally introduced (e.g. deck-v2`)
Otherwise: leave it alone.