id = "mkdocs" name = "MkDocs" description = "Project documentation with Markdown." homepage = "https://www.mkdocs.org" executables = ["mkdocs"] [commands] format = 1 label = "MkDocs" description = "Start a project, preview it locally or build the static site. Deployment to GitHub Pages is left out." quality = "ai-draft" base = "fig:mkdocs" parser = { end_of_options = "--", interleave = "permute", long_equals = true, short_attached = true, short_bundles = false } [[commands.source]] id = "fig" kind = "completion" url = "https://github.com/withfig/autocomplete/blob/master/src/mkdocs.ts" license = "MIT" [[commands.subcommand]] path = ["new"] label = "Create a new project" [[commands.subcommand.source]] id = "fig" kind = "completion" url = "https://github.com/withfig/autocomplete/blob/master/src/mkdocs.ts" license = "MIT" [[commands.subcommand.field]] id = "dir" label = "Project directory" type = "path" position = 0 path = { kind = "directory", role = "output" } sources = ["fig"] [[commands.subcommand.task]] id = "new" label = "New project" fields = ["dir"] required = ["dir"] [[commands.subcommand.group]] id = "basic" label = "Basic" fields = ["dir"] [[commands.subcommand]] path = ["serve"] label = "Preview locally" [[commands.subcommand.source]] id = "fig" kind = "completion" url = "https://github.com/withfig/autocomplete/blob/master/src/mkdocs.ts" license = "MIT" [[commands.subcommand.field]] id = "dev_addr" label = "Address" description = "IP:PORT, default localhost:8000." type = "string" option = ["--dev-addr", "-a"] sources = ["fig"] [[commands.subcommand.field]] id = "config_file" label = "Config file" type = "path" option = ["--config-file", "-f"] path = { kind = "file", role = "input" } sources = ["fig"] [[commands.subcommand.field]] id = "strict" label = "Strict mode" type = "boolean" option = ["--strict", "-s"] sources = ["fig"] [[commands.subcommand.field]] id = "no_reload" label = "Disable live reload" type = "boolean" option = ["--no-reload"] sources = ["fig"] [[commands.subcommand.task]] id = "serve" label = "Serve" fields = ["dev_addr", "config_file", "strict"] [[commands.subcommand.group]] id = "basic" label = "Basic" fields = ["dev_addr", "config_file", "strict", "no_reload"] [[commands.subcommand]] path = ["build"] label = "Build the site" [[commands.subcommand.source]] id = "fig" kind = "completion" url = "https://github.com/withfig/autocomplete/blob/master/src/mkdocs.ts" license = "MIT" [[commands.subcommand.field]] id = "config_file" label = "Config file" type = "path" option = ["--config-file", "-f"] path = { kind = "file", role = "input" } sources = ["fig"] [[commands.subcommand.field]] id = "site_dir" label = "Output directory" type = "path" option = ["--site-dir", "-d"] path = { kind = "directory", role = "output" } sources = ["fig"] [[commands.subcommand.field]] id = "strict" label = "Strict mode" description = "Abort the build on any warning." type = "boolean" option = ["--strict", "-s"] sources = ["fig"] [[commands.subcommand.field]] id = "clean" label = "Clean old files first" type = "boolean" option = ["--clean", "-c"] sources = ["fig"] [[commands.subcommand.field]] id = "theme" label = "Theme" type = "string" option = ["--theme", "-t"] sources = ["fig"] [[commands.subcommand.task]] id = "build" label = "Strict build" set = { strict = [true] } fields = ["config_file", "site_dir", "strict", "clean"] [[commands.subcommand.group]] id = "basic" label = "Basic" fields = ["config_file", "site_dir", "strict", "clean", "theme"]