Klenodexample

Documentation

Klenod Docs

A practical guide to Klenod's build graph, runtime bundles, assets, routing, templates, data imports, and built-in plugins.

Klenod is an experimental Ruby module bundler. It reads files from a configured source directory, resolves imports, transforms modules through plugins, records a dependency graph, and can serialize a runtime-only JSON bundle for production.

The core idea is to keep graph collection separate from Ruby module evaluation. Applications and frameworks can collect routes, templates, stylesheets, images, data files, and other dependencies without running app top-level code until an entry is actually called.

Packages

  • klenod-build owns graph construction, resolving, transforms, plugins, development watching, asset generation, the CLI, and bundle writing.
  • klenod-runtime owns runtime bundle loading, module evaluation, runtime asset specs, source maps, backtrace rewriting, and optional Ruby::Box loading.
  • klenod-rack owns Rack-compatible helpers for serving runtime assets.
  • klenod is the compatibility gem that brings the build and Rack pieces together.

Read Next

Getting StartedCreate a build context, import modules, build a bundle, and load it at runtime.Core ConceptsUnderstand collection, evaluation, imports, plugins, runtime bundles, and assets.ConfigurationConfigure entrypoints, output paths, plugin order, template factories, and asset options.Module GraphUnderstand collection, evaluation, eager imports, lazy imports, and glob imports.Haml ComponentsSee how Haml components, companion files, translations, and scoped CSS maps work together.AssetsWork with CSS, SVG, image variants, Google Fonts, and route-scoped asset lookup.Plugin ReferenceReview built-in plugins and the hook phases available to custom plugins.