@dr-ishaan/remake-blocks 1.1.0 → 1.3.0

package/dist/types.d.ts

@@ -192,6 +192,136 @@ export interface RemakeBlocksOptions {
      *   or has been sanitized.
      */
     allowDangerousHtml?: boolean;
+    /**
+     * Map of aliases for callout types. Aliases let users use shorter or
+     * alternative names for builtin or custom callout types.
+     *
+     * Keys are the canonical type (must exist in builtins or `customCallouts`).
+     * Values are arrays of alias names that will resolve to the canonical type.
+     *
+     * @example
+     * ```ts
+     * aliases: {
+     *   note: ["n", "info-note"],
+     *   tip: ["t"],
+     * }
+     * // Now `> [!N]` and `> [!INFO-NOTE]` render as `note` callouts.
+     * ```
+     *
+     * @default undefined (no aliases)
+     */
+    aliases?: Record<string, string[]>;
+    /**
+     * Whether to render icons in the callout title.
+     *
+     * - `true` (default): render the icon (builtin SVG or custom icon)
+     * - `false`: skip the icon entirely (no `<span class="callout-icon">`)
+     *
+     * Can be overridden per-callout via `> [!NOTE]{icon=false}` syntax.
+     *
+     * @default true
+     */
+    showIndicator?: boolean;
+    /**
+     * Default icon set for builtin callout types.
+     *
+     * - `"octicon"` (default): GitHub Octicons (current behavior)
+     * - `"lucide"`: Lucide icons (matching rehype-callouts' Obsidian theme)
+     * - `"emoji"`: Emoji icons (e.g. ℹ️ for note, 💡 for tip)
+     * - `"none"`: No icons (equivalent to `showIndicator: false`)
+     *
+     * Custom callouts always use their configured `icon` regardless of this option.
+     *
+     * @default "octicon"
+     */
+    iconSet?: "octicon" | "lucide" | "emoji" | "none";
+    /**
+     * Visual density / appearance for callouts.
+     *
+     * - `"default"` (default): Full callout with title bar, icon, border, background.
+     * - `"minimal"`: Reduced padding, smaller title, no background color.
+     * - `"simple"`: No title bar — title appears as bold inline text above body.
+     * - `"hidden"`: No title, no icon, just the body content with a left border.
+     *
+     * Can be overridden per-callout via `> [!NOTE]{appearance=minimal}` syntax.
+     *
+     * @default "default"
+     */
+    appearance?: "default" | "minimal" | "simple" | "hidden";
+    /**
+     * Tag names for the callout HTML structure. Override to customize the
+     * output HTML elements (e.g. use `<div>` instead of `<aside>`).
+     *
+     * @default { container: "aside", title: "div", icon: "span", titleText: "span", body: "div" }
+     */
+    tags?: {
+        container?: string;
+        title?: string;
+        icon?: string;
+        titleText?: string;
+        body?: string;
+    };
+    /**
+     * Per-callout-type additional HTML attributes. Can be a static object
+     * applied to all callouts of that type, or a function that returns
+     * attributes dynamically based on the parsed callout.
+     *
+     * The returned object's keys become HTML attributes; values are strings
+     * (or undefined to skip). Use this to add `dir`, `style`, custom `data-*`
+     * attributes, etc.
+     *
+     * @example
+     * ```ts
+     * props: {
+     *   note: { dir: "auto", "data-category": "info" },
+     *   // or as a function:
+     *   warning: (parsed) => ({ style: `--accent: ${parsed.collapsible ? "red" : "orange"}` }),
+     * }
+     * ```
+     *
+     * @default undefined
+     */
+    props?: Record<string, Record<string, string> | ((parsed: ParsedCallout) => Record<string, string>)>;
+    /**
+     * Custom render function (escape hatch). When provided, replaces the
+     * default HTML rendering entirely. Use this for full control over output.
+     *
+     * The function receives the parsed callout, the resolved config, the
+     * rendered body HTML, and the plugin options. It must return an HTML
+     * string.
+     *
+     * **Security note:** the returned HTML is injected as raw HTML. You are
+     * responsible for escaping user-supplied content (use the provided
+     * `escapeHtml` helper from the `escapeHtml` export).
+     *
+     * @example
+     * ```ts
+     * build: (parsed, config, bodyHtml, options) => {
+     *   return `<div class="my-callout my-callout-${parsed.type}">${bodyHtml}</div>`;
+     * }
+     * ```
+     *
+     * @default undefined (use built-in renderer)
+     */
+    build?: (parsed: ParsedCallout, config: CalloutConfig | undefined, bodyHtml: string, options: Required<RemakeBlocksOptions>) => string;
+    /**
+     * v1.3.0+: Enable `:::type[Title]` directive syntax (Starlight/Docusaurus compat).
+     *
+     * When `true`, the plugin detects `:::type` blocks in markdown and renders
+     * them as callouts. This allows content portability with Starlight, Docusaurus,
+     * MkDocs Material, and other tools that use the directive syntax.
+     *
+     * Supported syntax:
+     * - `:::note` ... `:::` — basic callout
+     * - `:::note[Custom Title]` ... `:::` — with custom title
+     * - `:::note{fold=-}` ... `:::` — with overrides (same as `> [!NOTE]-`)
+     * - `::::note` ... `::::` — 4-colon variant (for nesting)
+     *
+     * The directive syntax can be used alongside the standard `> [!NOTE]` syntax.
+     *
+     * @default false (opt-in for backward compatibility)
+     */
+    enableDirectiveSyntax?: boolean;
 }
 /**
  * Options for the `remake-blocks` Astro integration.
@@ -225,6 +355,13 @@ export interface ParsedCallout {
     collapsibleOpen: boolean;
     /** Whether this is a disclosure widget (plain collapsible, no color/icon) */
     isDisclosure: boolean;
+    /** Per-callout overrides parsed from `{key=value}` syntax. v1.2.0+. */
+    overrides?: {
+        icon?: boolean;
+        appearance?: "default" | "minimal" | "simple" | "hidden";
+        /** v1.3.0+: inline floating behavior. `inline` floats left, `inline-end` floats right. */
+        inline?: "inline" | "inline-end";
+    };
 }
 /**
  * Configuration map used internally for O(1) callout type lookup.

package/dist/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAMH;;;;;GAKG;AACH,MAAM,MAAM,kBAAkB,GAE1B,MAAM,GACN,KAAK,GACL,WAAW,GACX,SAAS,GACT,SAAS,GAET,UAAU,GACV,MAAM,GACN,SAAS,GACT,UAAU,GACV,SAAS,GACT,QAAQ,GACR,OAAO,GACP,KAAK,GACL,SAAS,GACT,MAAM,GAEN,SAAS,GACT,MAAM,GACN,MAAM,GACN,OAAO,GACP,MAAM,GACN,MAAM,GACN,KAAK,GACL,WAAW,GACX,MAAM,GACN,SAAS,GACT,OAAO,GACP,MAAM,CAAC;AAEX;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GAAG,MAAM,CAAC;AAEvC;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG,kBAAkB,GAAG,iBAAiB,CAAC;AAMjE;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,yEAAyE;IACzE,IAAI,EAAE,WAAW,CAAC;IAElB;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAMD;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;;;;;;;;;;;;;;;;;;OAmBG;IACH,cAAc,CAAC,EAAE,aAAa,EAAE,CAAC;IAEjC;;;OAGG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;;OAGG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAE7B;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;;;OAIG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAE1B;;;;;;OAMG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAE5B;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;;OAGG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B;;;OAGG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B;;;;;OAKG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAE1B;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;;OAKG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB;;;;;;;;;;;;;;;;;;OAkBG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;CAC9B;AAMD;;;;;GAKG;AACH,MAAM,WAAW,wBAAyB,SAAQ,mBAAmB;IACnE;;;;;OAKG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB;AAMD;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B,kEAAkE;IAClE,IAAI,EAAE,WAAW,GAAG,YAAY,CAAC;IACjC,8DAA8D;IAC9D,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,kEAAkE;IAClE,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,yCAAyC;IACzC,WAAW,EAAE,OAAO,CAAC;IACrB,yEAAyE;IACzE,eAAe,EAAE,OAAO,CAAC;IACzB,6EAA6E;IAC7E,YAAY,EAAE,OAAO,CAAC;CACvB;AAED;;;GAGG;AACH,MAAM,MAAM,gBAAgB,GAAG,GAAG,CAAC,WAAW,EAAE,aAAa,CAAC,CAAC"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAMH;;;;;GAKG;AACH,MAAM,MAAM,kBAAkB,GAE1B,MAAM,GACN,KAAK,GACL,WAAW,GACX,SAAS,GACT,SAAS,GAET,UAAU,GACV,MAAM,GACN,SAAS,GACT,UAAU,GACV,SAAS,GACT,QAAQ,GACR,OAAO,GACP,KAAK,GACL,SAAS,GACT,MAAM,GAEN,SAAS,GACT,MAAM,GACN,MAAM,GACN,OAAO,GACP,MAAM,GACN,MAAM,GACN,KAAK,GACL,WAAW,GACX,MAAM,GACN,SAAS,GACT,OAAO,GACP,MAAM,CAAC;AAEX;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GAAG,MAAM,CAAC;AAEvC;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG,kBAAkB,GAAG,iBAAiB,CAAC;AAMjE;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,yEAAyE;IACzE,IAAI,EAAE,WAAW,CAAC;IAElB;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAMD;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;;;;;;;;;;;;;;;;;;OAmBG;IACH,cAAc,CAAC,EAAE,aAAa,EAAE,CAAC;IAEjC;;;OAGG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;;OAGG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAE7B;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;;;OAIG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAE1B;;;;;;OAMG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAE5B;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;;OAGG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B;;;OAGG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B;;;;;OAKG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAE1B;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;;OAKG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB;;;;;;;;;;;;;;;;;;OAkBG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAI7B;;;;;;;;;;;;;;;;;OAiBG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;IAEnC;;;;;;;;;OASG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IAExB;;;;;;;;;;;OAWG;IACH,OAAO,CAAC,EAAE,SAAS,GAAG,QAAQ,GAAG,OAAO,GAAG,MAAM,CAAC;IAElD;;;;;;;;;;;OAWG;IACH,UAAU,CAAC,EAAE,SAAS,GAAG,SAAS,GAAG,QAAQ,GAAG,QAAQ,CAAC;IAEzD;;;;;OAKG;IACH,IAAI,CAAC,EAAE;QACL,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,IAAI,CAAC,EAAE,MAAM,CAAC;KACf,CAAC;IAEF;;;;;;;;;;;;;;;;;;;OAmBG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,aAAa,KAAK,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC;IAErG;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,KAAK,CAAC,EAAE,CACN,MAAM,EAAE,aAAa,EACrB,MAAM,EAAE,aAAa,GAAG,SAAS,EACjC,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE,QAAQ,CAAC,mBAAmB,CAAC,KACnC,MAAM,CAAC;IAEZ;;;;;;;;;;;;;;;;OAgBG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;CACjC;AAMD;;;;;GAKG;AACH,MAAM,WAAW,wBAAyB,SAAQ,mBAAmB;IACnE;;;;;OAKG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB;AAMD;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B,kEAAkE;IAClE,IAAI,EAAE,WAAW,GAAG,YAAY,CAAC;IACjC,8DAA8D;IAC9D,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,kEAAkE;IAClE,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,yCAAyC;IACzC,WAAW,EAAE,OAAO,CAAC;IACrB,yEAAyE;IACzE,eAAe,EAAE,OAAO,CAAC;IACzB,6EAA6E;IAC7E,YAAY,EAAE,OAAO,CAAC;IACtB,uEAAuE;IACvE,SAAS,CAAC,EAAE;QACV,IAAI,CAAC,EAAE,OAAO,CAAC;QACf,UAAU,CAAC,EAAE,SAAS,GAAG,SAAS,GAAG,QAAQ,GAAG,QAAQ,CAAC;QACzD,0FAA0F;QAC1F,MAAM,CAAC,EAAE,QAAQ,GAAG,YAAY,CAAC;KAClC,CAAC;CACH;AAED;;;GAGG;AACH,MAAM,MAAM,gBAAgB,GAAG,GAAG,CAAC,WAAW,EAAE,aAAa,CAAC,CAAC"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@dr-ishaan/remake-blocks",
-  "version": "1.1.0",
-  "description": "Astro 6 + remark plugin for GitHub-style callouts (admonitions), enhanced blockquotes, and disclosure widgets — 27 first-class types + safe-by-default HTML escaping",
+  "version": "1.3.0",
+  "description": "Astro 6 + remark plugin for GitHub-style callouts (admonitions), enhanced blockquotes, and disclosure widgets — 27 first-class types + 4 themes + inline callouts + directive syntax + safe-by-default HTML escaping + Lucide/emoji icon sets",
   "type": "module",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -15,7 +15,12 @@
     "./astro": {
       "import": "./dist/astro.js",
       "types": "./dist/astro.d.ts"
-    }
+    },
+    "./theme/github.css": "./dist/theme/github.css",
+    "./theme/obsidian.css": "./dist/theme/obsidian.css",
+    "./theme/vitepress.css": "./dist/theme/vitepress.css",
+    "./theme/docusaurus.css": "./dist/theme/docusaurus.css",
+    "./sanitize-schema.json": "./dist/sanitize-schema.json"
   },
   "files": [
     "dist/",
@@ -23,7 +28,7 @@
     "LICENSE"
   ],
   "scripts": {
-    "build": "tsc && cp src/styles.css dist/styles.css && cp src/accordion.js dist/accordion.js",
+    "build": "tsc && cp src/themes/github.css dist/styles.css && mkdir -p dist/theme && cp src/themes/*.css dist/theme/ && cp src/accordion.js dist/accordion.js && cp src/sanitize-schema.json dist/sanitize-schema.json",
     "dev": "tsc --watch",
     "test": "node --experimental-vm-modules tests/test-exhaustive.mts",
     "prepublishOnly": "npm run build"
@@ -46,7 +51,16 @@
     "obsidian-callout",
     "remake-blocks",
     "security",
-    "xss-safe"
+    "xss-safe",
+    "multi-theme",
+    "obsidian-theme",
+    "vitepress-theme",
+    "docusaurus-theme",
+    "inline-callouts",
+    "directive-syntax",
+    "lucide-icons",
+    "emoji-icons",
+    "rehype-sanitize"
   ],
   "license": "MIT",
   "author": "dr-ishaan <adi.ishaan@proton.me>",