SDML(1)

📦
version 0.3.2+20250310 · 3 versions
, in ubuntu resolute, ubuntu stonking

NAME 💖

sdml doc — bestie, this is the one that makes you structured documentation for a module. like, actual pretty docs, no cap. 📝

SYNOPSIS ✨

sdml doc [OPTIONS] [MODULE]

DESCRIPTION 🦋

okay so. sdml doc produces structured documentation for a module. that's the whole vibe. 💅

it creates structured documentation for a module, and it pulls in annotations, constraints, and all definition types — every single one, we're not leaving anybody out. the generated docs also come with diagrams and dependency graphs, which is genuinely so iconic of them. 🔥

you've got two flavors of output, and here's the tea on both:

  • Org-Mode (this is the default, jsyk) :: creates an Emacs org-mode formatted file. the way this format lets you write all the content into a single file with export options to <rainbow>HTML, LaTeX, Word, PDF and more</rainbow>?? obsessed. one file, infinite destinies. 🎀
  • Markdown :: creates a markdown formatted file. this one uses GitHub-flavored markdown, which means you get some better content formatting than plain old CommonMark. we love an upgrade. 💖

Arguments: 🌸

  • [MODULE] — an SDML module, loaded using the standard resolver. if you don't hand it one, it does its thing on its own, iykyk. 🧚

OPTIONS 👑

  • -f, --output-format <OUTPUT_FORMAT> — picks the format of your output. possible values: markdown (that's Markdown, bestie) and org-mode (that's Emacs org-mode). default is org-mode, so if you say nothing you get the org-mode treatment. 🫶
  • -o, --output <OUTPUT> — the file name to write to. or, plot twist, pass '-' and it writes to stdout instead. default is '-'. so yeah, stdout is the default destiny. ✨
  • -i, --input <INPUT> — the input SDML file name to read from. or, again with the plot twist, pass '-' and it reads from stdin. default is '-'. 💜
  • -h, --help — prints the help. quick note tho: this prints the full help — if you want just a summary, use '-h'. yes it's the same flag, it's giving lowercase main character energy, just roll with it. 😭
  • -V, --version — prints the version. capital V, don't forget. 👑
ngl bestie, remember: '-' is the magic little dash that means "stdin/stdout, not a file." don't go looking for a file literally named - on your disk. 🙈

and that's the whole page! 🎉 this was sdml doc version 0.3.2+20250310, from October 2025, and it lives in the User Commands section of the manual (that's SDML(1) if you're keeping track). slay, go document some modules, periodt. 💅🌈⭐

📦 where this page comes from