Crate htmeta

Source
Expand description

This crates implements a (simple) flavour of KDL called htmeta. This dialect’s purpose is to allow a straightforward representation of HTML.

§Format

As KDL is already very similar to HTML semantically, htmeta only adds 2 things:

  • A way to differentiate true text content to be shown in HTML.
  • Variables to reduce repetition.

§Text nodes

Text nodes are creatively named text and they can only have one positional argument, which is the text to be directly pasted into the resulting HTML.

Example:

html {
    body {
        h1 {
            text "Title"
        }
    }
}

Results in:

<html>
    <body>
        <h1>
            Title
        </h1>
    </body>
</html>

§Variables

If you ever used CSS-based frameworks like TailwindCSS or Bootstrap, you know how tedious it is to type the same classes over and over again. Hence, htmeta implements a simple variable mechanism that reduces duplication.

Example:

html {
    head {
        meta charset="utf-8"
        // Includes tailwindcss
        script src="https://cdn.tailwindcss.com"
    }
    body {
        // creates a variable called `$btn_class`
        $btn_class "border-1 rounded-lg"

        // Value of `$btn_class` is reused inside these buttons:
        button class="$btn_class ml-4"
        bttton class="$btn_class mr-4"
    }
}

Results in:

<html>
    <head>
        <meta charset="utf-8"/>
        <script src="https://cdn.tailwindcss.com"></script>
    </head>
    <body>
        <button class="border-1 rounded-lg ml-4"></button>
        <bttton class="border-1 rounded-lg mr-4"></bttton>
    </body>
</html>

Re-exports§

pub use kdl;

Structs§

HtmlEmitter
The HTML emitter for htmeta.
HtmlEmitterBuilder
A builder for HtmlEmitters.
PluginContext
Information that plugins can use to change what is being emitted.

Enums§

Error
The crate’s error type.

Traits§

IPlugin
A trait that allows you to hook into htmeta’s emitter and extend it!

Type Aliases§

EmitResult
Convenient alias for this crate’s return types.
Indent
The type used to represent indentation length.
Writer
Convenient alias for a std::io::Write mutable reference.