mkdocs-config-cli

CLI tool to generate and manage MkDocs documentation site configuration

Installation

npm install -g mkdocs-config-cli

Usage

Initialize configuration

mkdocs-config init
mkdocs-config init --template advanced
mkdocs-config init --output custom-config.json

Validate configuration

mkdocs-config validate
mkdocs-config validate path/to/config.json

View configuration

mkdocs-config show
mkdocs-config show --env production
mkdocs-config show --json

Modify configuration

mkdocs-config set settings.debug true
mkdocs-config set settings.logLevel \"warn\"

Compare configurations

mkdocs-config diff config-dev.json config-prod.json

List templates

mkdocs-config templates

Templates

| Template | Description | |----------|-------------| | minimal | Bare minimum configuration | | standard | Recommended defaults for most projects | | advanced | Full-featured with security, caching, and multi-environment support |

Why mkdocs-config-cli?

• Zero dependencies at runtime — just commander and chalk
• Template-based — start with minimal, standard, or advanced presets
• Validation built-in — catch config errors before deployment
• Environment-aware — manage dev/staging/production configs in one file
• Diff support — compare configs across environments

License

MIT