mr-md 1.0.0

package/dist/types.d.ts

@@ -0,0 +1,207 @@
+export type BlockType = "heading" | "markdown" | "section" | "important" | "note" | "warning" | "tip" | "simulation" | "animation" | "media" | "youtube" | "latex" | "columns" | "quiz" | "divider" | "code";
+export interface BaseBlock {
+    type: BlockType;
+}
+export interface HeadingBlock extends BaseBlock {
+    type: "heading";
+    src: string;
+    title?: string;
+}
+export interface MarkdownBlock extends BaseBlock {
+    type: "markdown";
+    src: string;
+}
+export interface SectionBlock extends BaseBlock {
+    type: "section";
+    src: string;
+    label?: string;
+}
+export interface CalloutBlock extends BaseBlock {
+    type: "important" | "warning" | "tip" | "note";
+    src: string;
+}
+export interface CodeBlock extends BaseBlock {
+    type: "code";
+    src: string;
+    lang?: string;
+    label?: string;
+}
+export type BlockAccent = "neutral" | "blue" | "teal" | "amber" | "rose" | "violet";
+export interface CaptionedBlock {
+    label?: string;
+    caption?: string;
+}
+export interface SimulationBlock extends BaseBlock, CaptionedBlock {
+    type: "simulation";
+    src: string;
+    props?: Record<string, unknown>;
+    tunables?: Record<string, SimulationControl>;
+    dependencies?: string[];
+    height?: number;
+    controls?: "interactive" | "observe";
+    accent?: BlockAccent;
+}
+export interface AnimationBlock extends BaseBlock, CaptionedBlock {
+    type: "animation";
+    src: string;
+    loop?: boolean;
+    height?: number;
+    accent?: BlockAccent;
+}
+export type MediaKind = "image" | "video" | "audio";
+export interface MediaBlock extends BaseBlock, CaptionedBlock {
+    type: "media";
+    src: string;
+    kind: MediaKind;
+    alt?: string;
+    credit?: string;
+    poster?: string;
+    controls?: boolean;
+}
+export interface YouTubeBlock extends BaseBlock, CaptionedBlock {
+    type: "youtube";
+    id: string;
+    start?: number;
+}
+export interface LatexBlock extends BaseBlock, CaptionedBlock {
+    type: "latex";
+    tex: string;
+    display?: boolean;
+}
+export interface ColumnItem {
+    src?: string;
+    markdown?: string;
+    latex?: string;
+    width?: string;
+}
+export interface ColumnsBlock extends BaseBlock, CaptionedBlock {
+    type: "columns";
+    columns: ColumnItem[];
+}
+export interface QuizBlock extends BaseBlock, CaptionedBlock {
+    type: "quiz";
+    src: string;
+}
+export interface DividerBlock extends BaseBlock {
+    type: "divider";
+}
+export type Block = HeadingBlock | MarkdownBlock | SectionBlock | CalloutBlock | CodeBlock | SimulationBlock | AnimationBlock | MediaBlock | YouTubeBlock | LatexBlock | ColumnsBlock | QuizBlock | DividerBlock;
+export interface LessonMeta {
+    title: string;
+    slug: string;
+    description?: string;
+    tags?: string[];
+    author?: string;
+    status?: "read" | "unread" | "locked";
+    parentSlug?: string;
+    prevSlug?: string;
+    prevTitle?: string;
+    nextSlug?: string;
+    nextTitle?: string;
+}
+export interface Lesson {
+    meta: LessonMeta;
+    blocks: Block[];
+}
+export interface LessonPreset {
+    layout?: "lesson" | "article" | "lab";
+    density?: "comfortable" | "compact";
+    tone?: "scholarly" | "studio" | "minimal";
+}
+export interface QuizQuestion {
+    q: string;
+    options: string[];
+    answer: number;
+    explanation?: string;
+}
+export interface QuizFile {
+    questions: QuizQuestion[];
+}
+/**
+ * Global configuration for building a lesson or chapter.
+ * Passed to `lesson(title, options)` or `chapter(title, options)`.
+ */
+export interface BuildOptions {
+    /** Directory where the generated HTML file will be written. Default: `'./out'` */
+    outDir?: string;
+    /** Base path for resolving local files like `.md`, `.js`, `.json`. Default: `'.'` */
+    contentBase?: string;
+    /** Light or dark mode. `auto` respects user system preferences. Default: `'auto'` */
+    theme?: "light" | "dark" | "auto";
+    /** Visual color palette of the generated page. Default: `'ink'` */
+    palette?: "ink" | "field" | "ember";
+    /** Custom CSS font-family string (e.g. `'Inter, sans-serif'`). */
+    font?: string;
+    /** Path to a favicon. */
+    favicon?: string;
+    /** Custom raw HTML to inject into the `<head>` tag. */
+    head?: string;
+    /** Preset for layout, density, and tone. */
+    preset?: LessonPreset;
+    /** If true, throws errors on missing files and invalid blocks to prevent silent failures. Default: `true` */
+    strict?: boolean;
+}
+/** Configuration for simulation blocks */
+export interface SimulationOptions {
+    props?: Record<string, unknown>;
+    tunables?: Record<string, SimulationControl>;
+    height?: number;
+    label?: string;
+    caption?: string;
+    controls?: SimulationBlock["controls"];
+    accent?: BlockAccent;
+}
+export interface SimulationConfig extends SimulationOptions {
+    dependencies?: string[];
+}
+/** Represents a single interactive control in a simulation (e.g., a slider) */
+export interface SimulationControl {
+    label?: string;
+    min?: number;
+    max?: number;
+    step?: number;
+}
+export interface AnimationOptions {
+    loop?: boolean;
+    height?: number;
+    label?: string;
+    caption?: string;
+    accent?: BlockAccent;
+}
+export interface MediaOptions {
+    kind?: MediaKind;
+    alt?: string;
+    label?: string;
+    caption?: string;
+    credit?: string;
+    poster?: string;
+    controls?: boolean;
+}
+export interface YouTubeOptions {
+    start?: number;
+    label?: string;
+    caption?: string;
+}
+export interface LatexOptions {
+    display?: boolean;
+    label?: string;
+    caption?: string;
+}
+export interface ColumnsOptions {
+    label?: string;
+    caption?: string;
+}
+/**
+ * Represents a logical grouping of multiple lessons.
+ */
+export interface ChapterMeta {
+    title: string;
+    slug: string;
+    description?: string;
+    status?: "completed" | "active" | "locked";
+}
+export interface Chapter {
+    meta: ChapterMeta;
+    lessons: Lesson[];
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,SAAS,GAClB,SAAS,GACT,UAAU,GACV,SAAS,GACT,WAAW,GACX,MAAM,GACN,SAAS,GACT,KAAK,GACL,YAAY,GACZ,WAAW,GACX,OAAO,GACP,SAAS,GACT,OAAO,GACP,SAAS,GACT,MAAM,GACN,SAAS,GACT,MAAM,CAAC;AAEV,MAAM,WAAW,SAAS;IACzB,IAAI,EAAE,SAAS,CAAC;CAChB;AAGD,MAAM,WAAW,YAAa,SAAQ,SAAS;IAC9C,IAAI,EAAE,SAAS,CAAC;IAChB,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,aAAc,SAAQ,SAAS;IAC/C,IAAI,EAAE,UAAU,CAAC;IACjB,GAAG,EAAE,MAAM,CAAC;CACZ;AAED,MAAM,WAAW,YAAa,SAAQ,SAAS;IAC9C,IAAI,EAAE,SAAS,CAAC;IAChB,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,YAAa,SAAQ,SAAS;IAC9C,IAAI,EAAE,WAAW,GAAG,SAAS,GAAG,KAAK,GAAG,MAAM,CAAC;IAC/C,GAAG,EAAE,MAAM,CAAC;CACZ;AAED,MAAM,WAAW,SAAU,SAAQ,SAAS;IAC3C,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,MAAM,WAAW,GACpB,SAAS,GACT,MAAM,GACN,MAAM,GACN,OAAO,GACP,MAAM,GACN,QAAQ,CAAC;AAEZ,MAAM,WAAW,cAAc;IAC9B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;CACjB;AAGD,MAAM,WAAW,eAAgB,SAAQ,SAAS,EAAE,cAAc;IACjE,IAAI,EAAE,YAAY,CAAC;IACnB,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAChC,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAC;IAC7C,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;IACxB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,aAAa,GAAG,SAAS,CAAC;IACrC,MAAM,CAAC,EAAE,WAAW,CAAC;CACrB;AAED,MAAM,WAAW,cAAe,SAAQ,SAAS,EAAE,cAAc;IAChE,IAAI,EAAE,WAAW,CAAC;IAClB,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,WAAW,CAAC;CACrB;AAED,MAAM,MAAM,SAAS,GAAG,OAAO,GAAG,OAAO,GAAG,OAAO,CAAC;AAEpD,MAAM,WAAW,UAAW,SAAQ,SAAS,EAAE,cAAc;IAC5D,IAAI,EAAE,OAAO,CAAC;IACd,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,SAAS,CAAC;IAChB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,MAAM,WAAW,YAAa,SAAQ,SAAS,EAAE,cAAc;IAC9D,IAAI,EAAE,SAAS,CAAC;IAChB,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,UAAW,SAAQ,SAAS,EAAE,cAAc;IAC5D,IAAI,EAAE,OAAO,CAAC;IACd,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,CAAC,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,UAAU;IAC1B,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,YAAa,SAAQ,SAAS,EAAE,cAAc;IAC9D,IAAI,EAAE,SAAS,CAAC;IAChB,OAAO,EAAE,UAAU,EAAE,CAAC;CACtB;AAED,MAAM,WAAW,SAAU,SAAQ,SAAS,EAAE,cAAc;IAC3D,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;CACZ;AAED,MAAM,WAAW,YAAa,SAAQ,SAAS;IAC9C,IAAI,EAAE,SAAS,CAAC;CAChB;AAED,MAAM,MAAM,KAAK,GACd,YAAY,GACZ,aAAa,GACb,YAAY,GACZ,YAAY,GACZ,SAAS,GACT,eAAe,GACf,cAAc,GACd,UAAU,GACV,YAAY,GACZ,UAAU,GACV,YAAY,GACZ,SAAS,GACT,YAAY,CAAC;AAIhB,MAAM,WAAW,UAAU;IAC1B,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,GAAG,QAAQ,GAAG,QAAQ,CAAC;IACtC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,MAAM;IACtB,IAAI,EAAE,UAAU,CAAC;IACjB,MAAM,EAAE,KAAK,EAAE,CAAC;CAChB;AAED,MAAM,WAAW,YAAY;IAC5B,MAAM,CAAC,EAAE,QAAQ,GAAG,SAAS,GAAG,KAAK,CAAC;IACtC,OAAO,CAAC,EAAE,aAAa,GAAG,SAAS,CAAC;IACpC,IAAI,CAAC,EAAE,WAAW,GAAG,QAAQ,GAAG,SAAS,CAAC;CAC1C;AAID,MAAM,WAAW,YAAY;IAC5B,CAAC,EAAE,MAAM,CAAC;IACV,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,QAAQ;IACxB,SAAS,EAAE,YAAY,EAAE,CAAC;CAC1B;AAID;;;GAGG;AACH,MAAM,WAAW,YAAY;IAC5B,kFAAkF;IAClF,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,qFAAqF;IACrF,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,qFAAqF;IACrF,KAAK,CAAC,EAAE,OAAO,GAAG,MAAM,GAAG,MAAM,CAAC;IAClC,mEAAmE;IACnE,OAAO,CAAC,EAAE,KAAK,GAAG,OAAO,GAAG,OAAO,CAAC;IACpC,kEAAkE;IAClE,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,yBAAyB;IACzB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,uDAAuD;IACvD,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,4CAA4C;IAC5C,MAAM,CAAC,EAAE,YAAY,CAAC;IACtB,6GAA6G;IAC7G,MAAM,CAAC,EAAE,OAAO,CAAC;CACjB;AAED,0CAA0C;AAC1C,MAAM,WAAW,iBAAiB;IACjC,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAChC,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAC;IAC7C,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,eAAe,CAAC,UAAU,CAAC,CAAC;IACvC,MAAM,CAAC,EAAE,WAAW,CAAC;CACrB;AAED,MAAM,WAAW,gBAAiB,SAAQ,iBAAiB;IAC1D,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;CACxB;AAED,+EAA+E;AAC/E,MAAM,WAAW,iBAAiB;IACjC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,gBAAgB;IAChC,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,WAAW,CAAC;CACrB;AAED,MAAM,WAAW,YAAY;IAC5B,IAAI,CAAC,EAAE,SAAS,CAAC;IACjB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,MAAM,WAAW,cAAc;IAC9B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,YAAY;IAC5B,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,cAAc;IAC9B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;CACjB;AAID;;GAEG;AACH,MAAM,WAAW,WAAW;IAC3B,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,CAAC,EAAE,WAAW,GAAG,QAAQ,GAAG,QAAQ,CAAC;CAC3C;AAED,MAAM,WAAW,OAAO;IACvB,IAAI,EAAE,WAAW,CAAC;IAClB,OAAO,EAAE,MAAM,EAAE,CAAC;CAClB"}

package/dist/types.js

@@ -0,0 +1,2 @@
+// ─── Block Types ─────────────────────────────────────────────────────────────
+export {};

package/package.json

@@ -0,0 +1,62 @@
+{
+	"name": "mr-md",
+	"version": "1.0.0",
+	"description": "Mr Markdown is an opinionated TypeScript SDK for building interactive, single-file learning pages.",
+	"type": "module",
+	"main": "dist/index.js",
+	"types": "dist/index.d.ts",
+	"exports": {
+		".": {
+			"types": "./dist/index.d.ts",
+			"import": "./dist/index.js",
+			"default": "./dist/index.js"
+		}
+	},
+	"files": [
+		"dist",
+		"src"
+	],
+	"directories": {
+		"demo": "demo"
+	},
+	"scripts": {
+		"build": "tsc -p tsconfig.build.json && mkdir -p dist/styles dist/client && cp -r src/styles/* dist/styles/ && cp -r src/client/* dist/client/",
+		"prepublishOnly": "bun run build",
+		"build:example": "bun demo/demo-1/course.ts",
+		"serve:example": "bunx serve demo/demo-1/out",
+		"typecheck": "bunx tsc --noEmit",
+		"test": "bun test && bun run typecheck",
+		"test:watch": "bun test --watch",
+		"lint": "biome lint .",
+		"format": "biome format --write .",
+		"check": "biome check --write ."
+	},
+	"keywords": [
+		"markdown",
+		"blog",
+		"interactive",
+		"education",
+		"shiki",
+		"katex",
+		"course"
+	],
+	"author": "Chirayu Chhabra",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/chirayuChhabra/blogkit.git"
+	},
+	"license": "ISC",
+	"devDependencies": {
+		"@types/katex": "^0.16.8",
+		"@types/node": "^25.8.0",
+		"biome": "^0.3.3",
+		"ts-node": "^10.9.2",
+		"typescript": "^6.0.3"
+	},
+	"dependencies": {
+		"highlight.js": "^11.11.1",
+		"katex": "^0.16.47",
+		"marked": "^18.0.4",
+		"marked-highlight": "^2.2.4"
+	}
+}