render-engine-clean-urls 0.1.0

Render-engine plugin that mirrors single pages to /<slug>/index.html so clean URLs resolve alongside the original .html files.

render-engine-clean-urls

A render-engine plugin that mirrors each single page's output to <slug>/index.html, so the page is reachable at the clean URL /<slug>/ in addition to the original /<slug>.html.

The plugin is non-destructive: the original <slug>.html file is left in place, and a copy is written at <slug>/index.html. Existing internal links of either form continue to work.

What gets rewritten

The plugin only mirrors top-level single pages that use the default route (["./"]). The following are skipped:

• The homepage (slug index by default)
• Collections and the pages they generate
• DataObjects
• Pages with an explicit class-level path_name
• Pages with a non-default routes value

Install

pip install render-engine-clean-urls

Or with uv:

uv add render-engine-clean-urls

Usage

from render_engine import Page, Site
from render_engine_clean_urls import CleanURLsPlugin

app = Site()
app.plugin_manager.register_plugin(CleanURLsPlugin)

@app.page
class About(Page):
    content_path = "about.html"

After app.render(), the output directory contains both:

output/about.html
output/about/index.html

so /about.html and /about/ both resolve to the same content.

Configuration

Skip additional slugs by registering with Site.register_plugins:

app.register_plugins(
    CleanURLsPlugin,
    CleanURLsPlugin={"skip_slugs": {"index", "robots"}},
)

skip_slugs defaults to {"index"}.

How it works

The plugin implements render-engine's post_build_site hook. After all pages have been rendered to disk, it walks site.route_list, identifies the single Page entries that should be mirrored, and copies each output/<slug>.html to output/<slug>/index.html.

Because the work happens after the normal build, the plugin doesn't change any page metadata, URLs returned by url_for(), or the site map.

License

MIT — see LICENSE.