Skip to content

docs(configuration): suggests naming convention for config files #851

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
avivkeller merged 1 commit into from
Jun 26, 2026
+2 −0
Merged

docs(configuration): suggests naming convention for config files #851

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
Loading