mr_markdown_builder

[ Back to module README ]


Examples Index

Every example below is generated by running its script against mr_markdown_builder — nothing here is written by hand. Regenerate all of them at once with npm run examples, or run an individual script (e.g. node examples/lists-example.js) to refresh just one. | Example | Regenerate with | Covers | | — | — | — | | Feature Showcase | node examples/feature-showcase.js | Every exported function, in one page. | | Headers & Emphasis | node examples/headers-and-emphasis.js | h1-h6, hX, bold, italic, strikethrough, inline/fenced code (with an optional language for syntax highlighting). | | Lists | node examples/lists-example.js | Ordered, unordered, and task lists — including checked task items and nesting. | | Tables | node examples/tables-example.js | Table headers and rows, with and without column alignment. | | Links, Images & Miscellaneous | node examples/links-and-media.js | Links, images, anchors, quotes, GitHub alerts, footnotes, badges, tags, collapsible sections, underline/sub/superscript, hard breaks, mentions, issue refs, emoji, color swatches, math, and comments. | | Diagrams: GeoJSON, TopoJSON & Mermaid | node examples/geoblocks-example.js | Fenced geojson/topojson blocks that GitHub renders as maps, and fenced mermaid blocks that GitHub renders as diagrams. | | Company Directory (real-world example) | node examples/index.js | A multi-file report generated from JSON company/interaction data — the most elaborate example in this directory. |