CHIBI-DOC(1)

🌸 NAME 🌸

chibi-doc — bestie, it generates documentation from Scheme scribble syntax 💖

---

✨ SYNOPSIS ✨

chibi-doc [-hst] [file]

chibi-doc dotted.name.of.module [identifier]

---

💅 DESCRIPTION 💅

okay so chibi-doc is literally a lil doc-generating icon 👑 it takes Scheme scribble syntax (yes, the one from Racket) and turns it into actual documentation. no cap.

it works exactly like a UNIX filter — it reads from the current input or from a file, and it writes the translated stuff straight to standard output. classic filter behavior, we love to see it 🫶

but wait, there's more ✨ you can also hand it a module name, with the components all separated by dots, and it'll go hunt down that module and generate the docs for you by processing the literate comments inside the module or any of its source files. and those comments? they're any line that begins with the characters

;;>

so cute, so simple 🎀

and the scribble syntax itself is described in the manual — go look, iykyk 💜

---

🦋 OPTIONS 🦋

• -h — output in HTML format (which is, fyi, the default) 🌈
• -s — output in SXML format ✨
• -t — output in text format (this one's the default when you're describing a single identifier) 💅

---

🎀 AUTHORS 🎀

Alex Shinn 💖

---

😭 REPORTING BUGS 😭

found a bug? tragic. please report it on Github 🙈

---

🌟 SEE ALSO 🌟

chibi-scheme(1)

---

quick vibe check: this whole thing is chibi-doc from the General Commands Manual, version 0.9 (fluorine), dated 2020-08-08. slay, periodt 💅✨🦋