lurkdown

library0.2.0jsnpmunverified

lurkdown is a command-line markdown transpiler tool that converts Markdown files to standalone HTML files. Built on Node.js with TypeScript, it automatically embeds local images as base64 to eliminate external dependencies. Version 0.2.0, released infrequently, offers two themes (dark/light), custom CSS injection, favicon support, and a config file option. Unlike other Markdown-to-HTML converters, it produces self-contained output with syntax highlighting via highlight.js, but lacks combined blockquotes and reference-style images. Best suited for quick documentation exports.

web-framework serialization

npm install lurkdown

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · LURKDOWN

lurkdown

web-frameworkjavascriptv0.2.0

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

default (CLI)

✓ lurkdown --files='./input.md'

lurkdown is primarily used via CLI. No JavaScript import; it's a binary.

Installs lurkdown globally and converts a single Markdown file with dark theme and custom title.

npm i -g lurkdown lurkdown --theme=dark --files='./input.md' --titles='My Doc' --outdir=./output

lurkdown --version

Debug

Known issues

gotchaCombined blockquotes and reference-style images are not supported.

fix

Use flat blockquotes and inline images instead.

affects: >=0.0.1

gotchaFont files are not embedded; you must host them externally and @import CSS.

fix

Add @import url('https://fonts.googleapis.com/...') via --styles or custom CSS.

affects: >=0.0.1

gotchaFile paths must be quoted and comma-separated; no spaces around commas.

fix

Use --files='./a.md,./b.md' (no space after comma).

affects: >=0.0.1

Errors

Common errors & fixes

Error: No input files specified

Missing --files argument.

fix

Add --files='./path/to/file.md'

Error: Theme 'nonexistent' not found. Available themes: dark, light

Invalid value for --theme.

fix

Use --theme=dark or --theme=light

Error: Cannot find module 'highlight.js'

Missing highlight.js dependency when using programmatic API (if applicable).

fix

Install highlight.js: npm i highlight.js

Upgrade

Version history

0.2.0latest on npm

Audit

Dependencies

No dependency data recorded yet.

Agent activity

3 hits · last 30 days

node

Amazon

Resources

githubhttps://github.com/obsfx/lurkdown ↗

packagehttps://www.npmjs.com/package/lurkdown ↗

homepagehttps://obsfx.github.io/lurkdown ↗