nakai
Nakai has several built-in “builders” that can be used.
-
A
documentbuilder (the recommend one) that renders a full HTML document, does a little magic to dedepulicate<head>elements, and some other things that generally fit the theme of “rendering a full, valid, HTML document”. It will generate a document which is configured to use UTF-8 encoding, as that is the encoding for allStrings in Gleam. -
An
inlinebuilder that should mostly be used for snippets, and partial bits of HTML that will be inlined into a full document; hence the name. It renders things much more literally. For example, if you tell it to give you a<head>element inside a<p>, it will. As a benefit for the trade off, it can be much faster for certain use cases.
Functions
pub fn to_inline_string(tree: Node) -> StringRenders only the provided HTML, exactly as provided (disables <head>
deduplication, etc.), into a String. Useful for generating snippets instead
of whole pages.
Examples
html.div_text([], "hello, lucy!")
|> nakai.to_inline_string()
pub fn to_inline_string_builder(tree: Node) -> StringBuilderRenders only the provided HTML, exactly as provided (disables <head>
deduplication, etc.), into a StringBuilder. Useful for generating snippets
instead of whole pages.
Examples
html.div_text([], "hello, lucy!")
|> nakai.to_inline_string_builder()
pub fn to_string(tree: Node) -> StringRenders a full HTML document from the given tree, into a String.
Since Strings in Gleam are always UTF-8 encoded, Nakai will automatically set
<meta charset="utf-8" />, as it’s the only option that makes sense, and will prevent
incorrect rendering of glyphs if you don’t set it yourself.
Examples
html.div_text([], "hello, lucy!")
|> nakai.to_string()
pub fn to_string_builder(tree: Node) -> StringBuilderRenders a full HTML document from the given tree, into a StringBuilder.
Since Strings in Gleam are always UTF-8 encoded, Nakai will automatically set
<meta charset="utf-8" />, as it’s the only option that makes sense, and will prevent
incorrect rendering of glyphs if you don’t set it yourself.
Examples
html.div_text([], "hello, lucy!")
|> nakai.to_string_builder()