lurkdown

0.2.0 verified Fri May 01 auth: no javascript

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.

Common errors

error Error: No input files specified ↓

cause Missing --files argument.

fix

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

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

cause Invalid value for --theme.

fix

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

error Error: Cannot find module 'highlight.js' ↓

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

fix

Install highlight.js: npm i highlight.js

Warnings

gotcha Combined blockquotes and reference-style images are not supported. ↓

fix Use flat blockquotes and inline images instead.

gotcha Font 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.

gotcha File paths must be quoted and comma-separated; no spaces around commas. ↓

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

Install

npm install lurkdown

yarn add lurkdown

pnpm add lurkdown

Imports

default (CLI)
```
lurkdown --files='./input.md'
```
lurkdown is primarily used via CLI. No JavaScript import; it's a binary.

Quickstart

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