Format

The Format header influences how the node body content will be interpreted when the site is generated.

The Format header has two valid values:

The default value is html.

When Format is set to html, the node body contents are not modified in any special way.

When Format is set to text, each newline in the node body content is followed by a <br> tag. This can be useful if you want node files to have basic text content, and have each line break represented in the generated HTML.

Whether you choose html or text, substitution parameters are still processed in the same manner.

Here are two example pages highlighting the difference:

Format: html

Format: text

Tags: headers

This page was generated by Uriel with the following settings:

Page Details

Resource Path Project File
Node headers/format/index nodes/headers/format/index
Template default.html templates/default.html
URL /headers/format/ public/headers/format/index.html

Node Headers

Header (Lowercase) Value
+-tags *
breadcrumb-separator &raquo;
canonical-url https://documentation.uriel.foo
rss-description Uriel Documentation
rss-image-height 32
rss-image-url /favicon-32x32.png
rss-image-width 32
rss-max-entries 50
rss-title Uriel Documentation
rss-url /rss.xml
sitemap-max-entries 10000
sitemap-url /sitemap.xml
tag-node tag
tags headers
template default.html

Node Timestamps

Type Value
Created
Modified 2026-06-05T17:43:23-04:00

Node Methods

Method Value
get_parent_node() headers/index
get_path() headers/format/index
get_node_type() file
get_url() /headers/format/
get_canonical_url() https://documentation.uriel.foo/headers/format/
get_name() format
get_display_name() Format
get_title() Format
get_escaped_title() Format
get_link() <a href="/headers/format/">Format</a>
get_canonical_link() <a href="https://documentation.uriel.foo/headers/format/">Format</a>
get_link_prefix() <p>
get_link_suffix() </p>
get_tags() ['headers']
get_dest_dir() ./public/headers/format
get_dest_file() ./public/headers/format/index.html
get_breadcrumb_separator() &raquo;