Documentation Guides

HTML Single Page #

This renderer creates a single self-contained HTML file from your entire documentation. All content, styles, and images are embedded inline, making it ideal for:

Tip

See a live example: The Rust Programming Language rendered as a single-page document.

Usage #

Build your documentation with the html-single renderer:

romero build --render html-single

Or serve it locally with live reload:

romero serve --render html-single

The output will be a single index.html file in your build directory.

Features #

Comparison with HTML #

Feature HTML HTML Single
Output Multiple files Single file
Navigation Sidebar + search Table of contents
Images Separate files Embedded (base64)
Offline Needs all files Self-contained
File size Smaller per-page Larger single file
Best for Websites Documents, PDFs