hyperctl render command

Overview


The hyperctl render command provides direct access to the underlying HyperTemplates rendering engine for generating HTML files from a layout and some data.

What is it good for? 🎵

When is it appropriate to use the hyperctl render command instead of hyperctl build or hyperctl generate? The hyperctl render command does not apply any of the opinions that are built in to the HyperTexting CMS. This makes it useful for things like the Learn HyperTemplates tutorial, and debugging.

Usage


 1$ hyperctl render -h
 2Render a HyperTemplate
 3
 4Usage:
 5        hyperctl render [options]
 6
 7Options:
 8        -d, --data    Path to a HyperTemplates data file (json, yaml, or markdown). (required) (env: HYPER_DATA)
 9        -l, --layout  Path to a HyperTemplates layout file (html).
10        -u, --untidy  Disable tidy mode.
11        -h, --help    Display help information.

Options


-d, --data
The path to the data file to use for the render.

The --data argument is required to render a layout.

-l, --layout
The path to the layout template to use for the render.

The --layout argument is required to render a layout.

-u, --untidy
Disable tidy mode.

See site.config.tidy_mode for more information.

Edit this page on GitHub

💬 Join the community

Stay up-to-date with the lastest releases and other news from Team HyperTemplates. Ask the developers questions, get help from the community, and share your creations! 🎨