mirror of
https://github.com/MillironX/Kelpie.jl.git
synced 2024-11-14 13:43:08 +00:00
Thomas A. Christensen II
e340ab4e26
Signed-off-by: Thomas A. Christensen II <25492070+MillironX@users.noreply.github.com>
90 lines
2.8 KiB
Markdown
90 lines
2.8 KiB
Markdown
# Kelpie
|
|
|
|
[](https://MillironX.github.io/Kelpie.jl/stable)
|
|
[](https://MillironX.github.io/Kelpie.jl/dev)
|
|
[](https://github.com/MillironX/Kelpie.jl/actions/workflows/CI.yml?query=branch%3Amaster)
|
|
[](https://codecov.io/gh/MillironX/Kelpie.jl)
|
|
[](https://github.com/invenia/BlueStyle)
|
|
[](https://JuliaCI.github.io/NanosoldierReports/pkgeval_badges/report.html)
|
|
[](https://pkgs.genieframework.com?packages=Kelpie)
|
|
|
|
:dog2: I accidentally built an HTML templating engine in Julia. It looked a lot
|
|
like [Pug](https://pugjs.org), but I like working dogs better, so I named it
|
|
Kelpie.
|
|
|
|
## Installation
|
|
|
|
You can install straight from the [Julia REPL]. Press `]` to enter [pkg mode],
|
|
then:
|
|
|
|
```julia
|
|
add Kelpie
|
|
```
|
|
|
|
## Usage
|
|
|
|
Most HTML elements[^1] now have functions of the same name: simply pass the contents
|
|
as a positional argument, and attributes as keyword arguments, and everything
|
|
will be returned as an [EzXML](https://github.com/JuliaIO/EzXML.jl) Document or
|
|
Node.
|
|
|
|
```julia
|
|
import EzXML: prettyprint
|
|
|
|
doc = html(
|
|
head(
|
|
title("Kelpie.jl is awesome!"),
|
|
),
|
|
body(
|
|
header(
|
|
h1("Dogs are cool"),
|
|
h2("Julia is cool"),
|
|
),
|
|
main(
|
|
img(;
|
|
src="/kelpie-on-sheep-back.jpg",
|
|
alt="A Kelpie herding sheep"
|
|
),
|
|
[
|
|
p("Kelpies make great herding dogs for $animal.")
|
|
for animal in ["cows", "sheep", "chickens"]
|
|
]...,
|
|
),
|
|
),
|
|
)
|
|
|
|
prettyprint(doc)
|
|
```
|
|
|
|
Turns into
|
|
|
|
```html
|
|
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
|
|
<!DOCTYPE html SYSTEM "about:legacy-compat">
|
|
<html>
|
|
<head>
|
|
<title>Kelpie.jl is awesome!</title>
|
|
</head>
|
|
<body>
|
|
<header>
|
|
<h1>Dogs are cool</h1>
|
|
<h2>Julia is cool</h2>
|
|
</header>
|
|
<main>
|
|
<img src="/kelpie-on-sheep-back.jpg" alt="A Kelpie herding sheep" />
|
|
<p>Kelpies make great herding dogs for cows.</p>
|
|
<p>Kelpies make great herding dogs for sheep.</p>
|
|
<p>Kelpies make great herding dogs for chickens.</p>
|
|
</main>
|
|
</body>
|
|
</html>
|
|
```
|
|
|
|
Everything is pure Julia, so your imagination is the limit!
|
|
|
|
[^1]:
|
|
Exception: `div` is the division function, and I wanted to leave it that
|
|
way. To make `<div>`s, you need to use `html_div`.
|
|
|
|
[julia repl]: https://docs.julialang.org/en/v1/manual/getting-started/
|
|
[pkg mode]: https://docs.julialang.org/en/v1/stdlib/Pkg/
|