MKDOCS(1)

🎀 MKDOCS(1) — General Commands Manual 🎀

okay so bestie, welcome to the MKDOCS(1) page from the General Commands Manual ✨ this is the whole thing, no cap.

🌸 NAME 🌸

mkdocs — Project documentation with Markdown

(that's literally it, short and slay 💅)

🌈 SYNOPSIS 🌈

mkdocs [-V] [-q] [-v] [-h] command

✨ DESCRIPTION ✨

mkdocs builds markdown based project documentation. that's the main character energy right there 🫶

💖 OPTIONS 💖

• -V, --version — Show the version and exit. (like, bye bestie, version shown, exit)
• -q, --quiet — Show the version and exit. (yes bestie, the manpage says the exact same thing as --version, no cap, not me editing it, it's giving copy-paste energy but we keep it fr fr)
• -v, --verbose — Enable verbose output. (spill the tea, mkdocs, tell me everything)
• -h, --help — Show this message and exit. (the classic, iconic, never misses)

👑 COMMANDS 👑

• build — Build the MkDocs documentation. (make the docs, periodt)
• gh-deploy — Deploy your documentation to GitHub Pages. (push it to the cloud, slay)
• new — Create a new MkDocs project. (fresh start, main character moment)
• serve — Run the builtin development server. (local vibes, test it out)

and that's the whole page, bestie. the footer says MKDOCS(1) at the very bottom, like the manual name again, and the source/version is just that — MKDOCS(1), General Commands Manual, no date in the footer, so that's the sign-off. periodt. 💅🦋