HUGO-GEN-DOC(1)

📦
version 0.169.0 · 13 versions
, in arch rolling

💅 HUGO-GEN-DOC(1) 💅

ok so this is a page from the Hugo Manual, and honestly? it's giving "behind the scenes queen." sit down bestie, we're learning about the doc generator 🎀

✨ NAME ✨

hugo-gen-doc — generate Markdown documentation for the Hugo CLI 🦋

✨ SYNOPSIS ✨

hugo gen doc [flags] [args]

that's it. that's the whole vibe. flags, args, go. 🫶

🌸 DESCRIPTION 🌸

okay so, real talk: this command generates Markdown documentation for the Hugo CLI. 💖

lowkey, it's mostly used to create up-to-date documentation of Hugo's command-line interface for https://gohugo.io/ — no cap, that's literally its main character job. 👑

and here's the slay part: it creates one Markdown file per command, each one with front matter suitable for rendering in Hugo. so every command gets its own lil file, dressed up and ready to render. it's giving organized. it's giving prepared. we love to see it. ✨

🎀 OPTIONS 🎀

  • --dir="/tmp/hugodoc/" — the directory to write the doc. yep, that's the default right there, /tmp/hugodoc/. 💅
  • -h, --help[=false] — help for doc. the classic. when in doubt, ask for help bestie 🫶

🦋 OPTIONS INHERITED FROM PARENT COMMANDS 🦋

these are the ones you get for free from the parent command — inherited, like your mom's good taste 💜

  • --clock="" — set the clock used by Hugo, e.g. --clock 2021-11-06T22:30:00.00+09:00. yes, you can time travel (for Hugo's purposes). iconic ⭐
  • --config="" — config file (default is hugo.yaml|json|toml). it'll find it, don't stress 😌
  • --configDir="config" — config dir. default's config, cute and simple 🎀
  • -d, --destination="" — filesystem path to write files to. where the output goes 🍓
  • -e, --environment="" — build environment. tell Hugo what era we're in 🌈
  • --ignoreVendorPaths="" — ignores any _vendor for module paths matching the given Glob pattern. glob girlies rise 🙈
  • --logLevel="" — log level (debug|info|warn|error). pick your volume 🔥
  • --noBuildLock[=false] — don't create .hugo_build.lock file. no lock, no problem 💀
  • --quiet[=false] — build in quiet mode. shhh 🤫
  • -M, --renderToMemory[=false] — render to memory (mostly useful when running the server). in-memory, no disk, very demure 🧚
  • -s, --source="" — filesystem path to read files relative from. your source of truth 💖
  • --themesDir="" — filesystem path to themes directory. all the aesthetics live here ✨

🌟 SEE ALSO 🌟

ngl, that's the whole page. nothing dangerous here, no deprecated chaos, just a very tidy documentation generator doing its thing. 🦋

okay bye ily!! this page was brought to you by Hugo 0.169.0, dated Oct 2026 — see you in the next manpage bestie 💜✨

📦 where this page comes from