Skip to content

Commit 14a7014

Browse files
docs(configuration): suggests naming convention for config files (#851)
1 parent e7170f2 commit 14a7014

1 file changed

Lines changed: 2 additions & 0 deletions

File tree

docs/configuration.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@
33
`doc-kit`'s CLI supports a `--config-file` option, allowing for custom configuration files to be passed.
44
These configuration files must be loadable via a `import()` call, so usually JSON or JavaScript files with default exports.
55

6+
By convention, this file is usually named `doc-kit.config.mjs` or `doc-kit.config.json`.
7+
68
## Configuration File Format
79

810
Configuration files can be either:

0 commit comments

Comments
 (0)