From ab4dbf46e073713f223894221989ee7a798099f4 Mon Sep 17 00:00:00 2001 From: bmuenzenmeyer Date: Wed, 24 Jun 2026 07:56:30 -0500 Subject: [PATCH] docs(configuration): suggests naming convention for config files --- docs/configuration.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/configuration.md b/docs/configuration.md index 9a073e74..52843462 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -3,6 +3,8 @@ `doc-kit`'s CLI supports a `--config-file` option, allowing for custom configuration files to be passed. These configuration files must be loadable via a `import()` call, so usually JSON or JavaScript files with default exports. +By convention, this file is usually named `doc-kit.config.mjs` or `doc-kit.config.json`. + ## Configuration File Format Configuration files can be either: