Skip to content

Commit 0645b18

Browse files
committed
docs(docs/config): state customize supports all config formats
1 parent e508091 commit 0645b18

3 files changed

Lines changed: 4 additions & 3 deletions

File tree

docs/config/configuration_file.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -244,4 +244,4 @@ Key configuration categories include:
244244
For advanced customization, including creating custom commit rules, see the [Customization](../customization/config_file.md) documentation.
245245

246246
!!! note
247-
The `customize` option is only supported when using TOML configuration files.
247+
The `customize` option is supported in TOML, JSON, and YAML configuration files. For Python projects, adding it to `pyproject.toml` keeps all project configuration in one place.

docs/config/option.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ Style for the prompts (It will merge this value with default style.) See [Stylin
2626
- Type: `dict`
2727
- Default: `None`
2828

29-
**This is only supported when config through `toml` configuration file.**
29+
**Supported in TOML, JSON, and YAML configuration files.**
3030

3131
Custom rules for committing and bumping. See [customization](../customization/config_file.md) for more details.
3232

mkdocs.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ nav:
5555
- changelog: "config/changelog.md"
5656
- Misc Options: "config/option.md"
5757
- Advanced Customization:
58-
- Configuration File: "customization/config_file.md"
58+
- Customize via config file: "customization/config_file.md"
5959
- Customized Python Class: "customization/python_class.md"
6060
- Changelog Template: "customization/changelog_template.md"
6161
- Tutorials:
@@ -105,6 +105,7 @@ markdown_extensions:
105105
- name: mermaid
106106
class: mermaid
107107
format: !!python/name:pymdownx.superfences.fence_code_format
108+
- pymdownx.tabbed
108109

109110
plugins:
110111
- search

0 commit comments

Comments
 (0)