mmi-ts

TypeScript implementation of mmi markbook tooling.

Install

npm install -g mmi-ts

CLI

mmi-ts -server -port 18080 ./guide
mmi-ts -summary ./guide
mmi-ts -json ./guide

mmi-ts scans Markdown files that contain YAML frontmatter:

---
title: Example Page
order: 1
---

title and numeric order are required. order must be unique among sibling pages.

Renderer plugins

Renderer plugins can register a named renderer:

import { registerRenderer } from "mmi-ts/renderer";

registerRenderer({
  name: "custom",
  render(markdown, context) {
    return `<main data-title="${context.title}">${markdown}</main>`;
  },
});

Use frontmatter to select a renderer:

---
title: Custom Page
order: 1
renderer: custom
---