Basics

A plain fence

No options at all. The language comes from the fence, the frame is chosen automatically, and line numbers come from defaults.lineNumbers in kazari.config.yaml.

1
package main
2
3
import "fmt"
4
5
func main() {
6
  fmt.Println("hello")
7
}

A title

title puts a name in the toolbar, after the language badge and its separator. The icon at the far left of the badge is an empty span that Kazari emits and this site fills from static/site.css, since Kazari ships no icon art of its own.

1
package main
2
3
import "net/http"
4
5
func main() {
6
  http.ListenAndServe(":8080", nil)
7
}

A title from the code itself

With no title attribute, a file name in the first line comment becomes the title and the comment is removed from the rendered code. This needs no render hook, so it works on any Hugo site.

1
export function register(app) {
2
  app.get("/health", (req, res) => res.send("ok"));
3
}

Line numbers off, and a different start

showlinenumbers="false" overrides the site default for one block. startlinenumber renumbers an excerpt to match its source file.

type Config struct {
  Addr string
  TLS  bool
}

42
func handle(w http.ResponseWriter, r *http.Request) {
43
  if r.Method != http.MethodGet {
44
    w.WriteHeader(http.StatusMethodNotAllowed)
45
    return
46
  }
47
  w.Write([]byte("ok"))
48
}

Terminal frames

Shell languages get a terminal frame automatically, with no attribute needed.

1
go build ./...
2
kazari process public

A title names the terminal window without changing the frame.

1
hugo --minify
2
kazari process --config kazari.config.yaml public
3
rsync -a public/ deploy@example.org:/srv/www/

When a shell block is a file

Detection looks at the code, not at the title. A shebang or a file name comment in the first few lines means the block is a script file rather than a session, so it gets an editor frame instead.

1
#!/usr/bin/env bash
2
set -euo pipefail
3
hugo --minify
4
kazari process --config kazari.config.yaml public

Forcing a frame

frame overrides detection entirely. frame="terminal" puts the window chrome back on the script above, frame="code" does the reverse, and frame="none" drops the chrome and leaves the highlighted code on its own.

1
#!/usr/bin/env bash
2
set -euo pipefail
3
hugo --minify

1
curl -sSfL https://example.org/install.sh | sh

Wrapping long lines

wrap="true" soft wraps instead of scrolling sideways. hangingindent="4" indents the continuation of a wrapped line so it stays visually attached to the line it belongs to.

ERROR failed to reconcile deployment "api-gateway" in namespace "production": admission webhook "validate.example.org" denied the request: container "gateway" must declare a memory limit

Mermaid stays untouched

Mermaid fences pass straight through. The processor recognises them and leaves the block alone so a diagram renderer on the page can claim it.

graph LR
  A[hugo] --> B[public/]
  B --> C[kazari process]
  C --> D[framed blocks]