Koenig Markdown Html Renderer

Markdown to HTML rendering for Ghost's markdown card.

Install

npm install @tryghost/kg-markdown-html-renderer

Usage

import {render} from '@tryghost/kg-markdown-html-renderer';

render('# Hello');
// '<h1 id="hello">Hello</h1>\n'

Headings are given generated ids. Pass {ghostVersion: '3.0'} to get the pre-4.0 slug format, which older content's anchor links depend on:

render('## Hello, World!');
// '<h2 id="hello-world">Hello, World!</h2>\n'

render('## Hello, World!', {ghostVersion: '3.0'});
// '<h2 id="helloworld">Hello, World!</h2>\n'

Develop

This package is part of the Ghost monorepo and resolves through the pnpm workspace — there is no linking or per-package install step. Run pnpm bootstrap in the monorepo root, then work in koenig/kg-markdown-html-renderer.

See the Koenig README for the shared build, test and release workflow.

Test

• pnpm test:unit runs the unit tests
• pnpm test runs the unit and type tests, including coverage thresholds
• pnpm lint runs the lint checks

Copyright & License

Copyright (c) 2013-2026 Ghost Foundation - Released under the MIT license.