ndg(1)

📦
version 2.10.2 · 2 versions
, in nixpkgs unstable

💅 ndg — like, the whole manual, bestie

okay so real talk — you opened section 1 of the General Commands Manual, and the star of the show is ndg. That's the command name, that's the vibe, that's the whole thing. let's get into it 🫶

✨ NAME ✨

ndg — short for NDG: Not a Docs Generator. yes that's the actual name. it's a whole recursive bit and honestly? iconic. 👑

🌸 SYNOPSIS 🌸

ndg [-v|--verbose]... [-q|--quiet]... [-c|--config-file] [--config]
    [-h|--help] [-V|--version] [subcommands]

so yeah — stack your flags however you like, tack on a subcommand at the end, and it does the thing. slay.

🦋 DESCRIPTION 🦋

NDG: Not a Docs Generator

that's it. that's the description. the manpage said it, I'm saying it, we're all saying it together. no cap. 💀

🎀 OPTIONS 🎀

  • -v, --verbose — turn the logging up. more words, more details, more knowing what's going on. you can pass it over and over if you really wanna be nosy. 👀
  • -q, --quiet — turn the logging down. shhh. also stackable, so you can go full silent-mode if that's your mood. 🙈
  • -c, --config-file <CONFIG_FILES> — the path (or paths!) to your configuration file(s). takes TOML or JSON, and you can specify it multiple times. multiple files get merged in order, and later files override earlier ones — so the last one wins, periodt. 🔥
  • --config <CONFIG_OVERRIDES> — override config values right there on the command line, in KEY=VALUE format. also repeatable, so go off. ✨
  • -h, --help — print the help. your classic cry-for-help-but-cute button. 🫶
  • -V, --version — print the version. yes it's a capital V, don't @ me. 💅

🌈 SUBCOMMANDS 🌈

  • ndg-init(1) — initialize a brand-new NDG configuration file. fresh start, fresh config, main character energy. 🧚
  • ndg-export(1) — export the default templates out to a directory so you can customize them however you want. make it yours. 💖
  • ndg-html(1) — process documentation and generate HTML. the web version, obviously. ⭐
  • ndg-man(1) — generate a manpage from options. yeah. it makes manpages. meta, I know. 😭
  • ndg-pdf(1) — generate a PDF from options. for when you need it to be, like, printable. 🍓
  • ndg-help(1) — print this message, or the help of whichever subcommand you point it at. the helper's helper. 👑
ngl, each of these bad boys has its own manpage — hit them up if you want the full tea. ☕

⭐ VERSION ⭐

v2.10.2

okay that's the whole page, bestie, you ate that reading session 💅✨

shoutout to ndg version 2.10.2 for making this all happen, and remember: this was your friendly neighborhood ndg(1) page — manual, section 1, built from the ndg 2.10.2 release. go forth and generate (not docs, apparently). 🦋🌸💜

📦 where this page comes from