mf2dom

Render Microformats2 JSON to semantic HTML.

Installation

``bash
npm install mf2dom
`

Usage

$3

`javascript
import { render, renderItems, renderItemElement } from 'mf2dom';

// Render a full mf2 document
const html = render(mf2Document);

// Render multiple items to a DocumentFragment
const fragment = renderItems(items, { topHeading: 2 });
document.querySelector('main').appendChild(fragment);

// Render a single item to an HTMLElement
const element = renderItemElement(item, { topHeading: 2 });
`

$3

`html


`

$3

`javascript
import { render } from 'mf2dom';
import { JSDOM } from 'jsdom';

// Set up global document for Node.js
const dom = new JSDOM('');
global.document = dom.window.document;

const html = render(mf2Document);
`

API

$3

Render an mf2 document to HTML.

- doc: Microformats2 document with items array
- options.asElement: Return HTMLElement instead of string (default: false)
- options.topHeading: Starting heading level for names (1-6)

$3

Render multiple mf2 items to a DocumentFragment.

- items: Array of mf2 items
- options.relUrls: rel-urls from parsed document
- options.topHeading: Starting heading level

$3

Render a single mf2 item to an HTMLElement.

- item: Single mf2 item
- options.relUrls: rel-urls from parsed document
- options.topHeading: Starting heading level

Features

- Renders h-entry, h-card, h-feed, h-event, and other microformat types
- Semantic HTML output (article, address, time, etc.)
- Proper heading hierarchy with topHeading` option
- Handles embedded items (author h-cards, location, etc.)
- Ruby annotations for names with IPA pronunciation
- Linked names when URL matches
- Media handling (photo, video, audio)
- Date/time formatting

License

AGPL-3.0-or-later