[autofix] Format Markdown

Author: kdeldycke

docs/commands.md

@@ -7,7 +7,9 @@ Click Extra aims to be a drop-in replacement for Click. The vast majority of Cli
 Here is for instance the [canonical `click` example](https://github.com/pallets/click#a-simple-example) with all original imports replaced with `click_extra`:
 
 ```{click:example}
-:emphasize-lines: 1
+---
+emphasize-lines: 1
+---
 from click_extra import command, echo, option
 
 @command
@@ -110,7 +112,9 @@ The `@extra_command` and `@extra_group` decorators are [pre-configured with a se
 You can remove all default options by resetting the `params` argument to `None`:
 
 ```{click:example}
-:emphasize-lines: 3
+---
+emphasize-lines: 3
+---
 from click_extra import extra_command
 
 @extra_command(params=None)
@@ -140,7 +144,9 @@ As you can see, all options are stripped out, but the colouring and formatting o
 To override the default options, you can provide the `params=` argument to the command. But note how we use classes instead of option decorators:
 
 ```{click:example}
-:emphasize-lines: 4-7
+---
+emphasize-lines: 4-7
+---
 from click_extra import extra_command, ConfigOption, VerbosityOption
 
 @extra_command(
@@ -156,7 +162,9 @@ def cli():
 And now you get:
 
 ```{click:run}
-:emphasize-lines: 5-9
+---
+emphasize-lines: 5-9
+---
 from textwrap import dedent
 result = invoke(cli, args=["--help"])
 assert result.stdout.startswith(dedent(
@@ -171,7 +179,9 @@ assert result.stdout.startswith(dedent(
 This let you replace the preset options by your own set, tweak their order and fine-tune their defaults.
 
 ````{admonition} Duplicate options
-:class: caution
+---
+class: caution
+---
 If you try to add option decorators to a command which already have them by default, you will end up with duplicate entries ([as seen in issue #232](https://github.com/kdeldycke/click-extra/issues/232)):
 
 ```{click:example}
@@ -221,7 +231,9 @@ For example, the [`--verbosity` option defaults to the `WARNING` level](logging.
 If you manage your own `--verbosity` option, you can [pass the `default` argument to its decorator like we did above](#change-default-options):
 
 ```{click:example}
-:emphasize-lines: 4
+---
+emphasize-lines: 4
+---
 from click_extra import command, verbosity_option
 
 @command
@@ -233,7 +245,9 @@ def cli():
 This also works in its class form:
 
 ```{click:example}
-:emphasize-lines: 3
+---
+emphasize-lines: 3
+---
 from click_extra import command, VerbosityOption
 
 @command(params=[VerbosityOption(default="INFO")])
@@ -244,7 +258,9 @@ def cli():
 But you also have the alternative to pass a `default_map` via the `context_settings`:
 
 ```{click:example}
-:emphasize-lines: 3
+---
+emphasize-lines: 3
+---
 from click_extra import extra_command
 
 @extra_command(context_settings={"default_map": {"verbosity": "INFO"}})
@@ -255,7 +271,9 @@ def cli():
 Which results in `[default: INFO]` being featured in the help message:
 
 ```{click:run}
-:emphasize-lines: 17
+---
+emphasize-lines: 17
+---
 result = invoke(cli, args=["--help"])
 assert "\x1b[2m[\x1b[0m\x1b[2mdefault: \x1b[0m\x1b[32m\x1b[2m\x1b[3mINFO\x1b[0m\x1b[2m]\x1b[0m\n" in result.stdout
 ```
@@ -355,7 +373,9 @@ if __name__ == "__main__":
 And this simple script gets rendered into:
 
 ```{code-block} shell-session
-:emphasize-lines: 22-23
+---
+emphasize-lines: 22-23
+---
 $ uv run -- python ./wrap.py
 Usage: wrap.py [OPTIONS] COMMAND [ARGS]...
 
@@ -522,7 +542,9 @@ Examples:
 Here is the highlighted differences to make them even more obvious:
 
 ```{code-block} diff
-:emphasize-lines: 2-5,13-14
+---
+emphasize-lines: 2-5,13-14
+---
 @@ -1,5 +1,5 @@
 -$ uv run -- python ./wrap.py aws_sam --help
 -Usage: wrap.py aws_sam [OPTIONS] COMMAND [ARGS]...

docs/config.md

@@ -9,7 +9,9 @@ data structure to mirror the CLI.
 The `@config_option` decorator provided by Click Extra can be used as-is with vanilla Click:
 
 ```{click:example}
-:emphasize-lines: 7
+---
+emphasize-lines: 7
+---
 from click import group, option, echo
 from click_extra import config_option
 
@@ -32,7 +34,9 @@ The code above is saved into a file named `my_cli.py`.
 It produces the following help screen:
 
 ```{click:run}
-:emphasize-lines: 7-10
+---
+emphasize-lines: 7-10
+---
 result = invoke(my_cli, args=["--help"])
 assert "-C, --config CONFIG_PATH" in result.stdout
 ```
@@ -107,7 +111,9 @@ The parameter will take the first value set in that chain.
 See how inline parameters takes priority on defaults from the previous example:
 
 ```{code-block} shell-session
-:emphasize-lines: 1, 4
+---
+emphasize-lines: 1, 4
+---
 $ my-cli subcommand --int-param 555
 dummy_flag    is True
 my_list       is ('item 1', 'item #2', 'Very Last Item!')
@@ -121,7 +127,9 @@ After gathering all the configuration from the different sources, and assembling
 You can still access the full configuration by looking into the context's `meta` attribute:
 
 ```{code-block} python
-:emphasize-lines: 9-12
+---
+emphasize-lines: 9-12
+---
 from click_extra import option, echo, pass_context, command, config_option
 
 
@@ -147,7 +155,9 @@ dummy_flag = true
 ```
 
 ```{code-block} shell-session
-:emphasize-lines: 3-6
+---
+emphasize-lines: 3-6
+---
 $ my-cli --config ./conf.toml --int-param 999
 Load configuration matching ./conf.toml
 Configuration location: /home/me/conf.toml
@@ -181,7 +191,9 @@ random_param = "forbidden"
 The use of `strict=True` parameter in the CLI below:
 
 ```{code-block} python
-:emphasize-lines: 7
+---
+emphasize-lines: 7
+---
 from click import command, option, echo
 
 from click_extra import config_option
@@ -196,7 +208,9 @@ def cli(int_param):
 Will raise an error and stop the CLI execution on unrecognized `random_param` value:
 
 ```{code-block} shell-session
-:emphasize-lines: 4
+---
+emphasize-lines: 4
+---
 $ cli --config "cli.toml"
 Load configuration matching cli.toml
 (...)
@@ -212,7 +226,9 @@ It {py:attr}`defaults to the value of ParamStructure.DEFAULT_EXCLUDED_PARAMS <cl
 You can set your own list of option to ignore with the `excluded_params` argument:
 
 ```{code-block} python
-:emphasize-lines: 7
+---
+emphasize-lines: 7
+---
 from click import command, option, echo
 
 from click_extra import config_option
@@ -274,7 +290,9 @@ garbage: >
 ```
 
 ```{code-block} shell-session
-:emphasize-lines: 2-4
+---
+emphasize-lines: 2-4
+---
 $ my-cli --config "~/.config/my-cli/config.yaml" subcommand
 dummy_flag    is True
 my_list       is ('point 1', 'point #2', 'Very Last Point!')
@@ -308,7 +326,9 @@ Again, same for JSON:
 ```
 
 ```{code-block} shell-session
-:emphasize-lines: 2-4
+---
+emphasize-lines: 2-4
+---
 $ my-cli --config "~/.config/my-cli/config.json" subcommand
 dummy_flag    is True
 my_list       is ('item 1', 'item #2', 'Very Last Item!')
@@ -367,7 +387,9 @@ Like the latter, the `@config_option` decorator and `ConfigOption` class accept
 Let's change the default base folder in the following example:
 
 ```{click:example}
-:emphasize-lines: 6
+---
+emphasize-lines: 6
+---
 from click import command
 
 from click_extra import config_option
@@ -381,7 +403,9 @@ def cli():
 See how the default to `--config` option has been changed to `~/.cli/*.{toml,yaml,yml,json,ini,xml}`:
 
 ```{click:run}
-:emphasize-lines: 7
+---
+emphasize-lines: 7
+---
 result = invoke(cli, args=["--help"])
 assert "~/.cli/*.{toml,yaml,yml,json,ini,xml}]" in result.stdout
 ```
@@ -393,7 +417,9 @@ If you'd like to customize the pattern, you can pass your own to the `default` p
 Here is how to look for an extension-less YAML dotfile in the home directory, with a pre-defined `.commandrc` name:
 
 ```{click:example}
-:emphasize-lines: 7
+---
+emphasize-lines: 7
+---
 from click import command
 
 from click_extra import config_option
@@ -406,7 +432,9 @@ def cli():
 ```
 
 ```{click:run}
-:emphasize-lines: 7
+---
+emphasize-lines: 7
+---
 result = invoke(cli, args=["--help"])
 assert "~/.commandrc]" in result.stdout
 ```
@@ -452,7 +480,9 @@ As soon as a file is able to be parsed without error and returns a `dict`, the s
 If you know in advance the only format you'd like to support, you can use the `formats` argument on your decorator like so:
 
 ```{click:example}
-:emphasize-lines: 8
+---
+emphasize-lines: 8
+---
 from click import command, option, echo
 
 from click_extra import config_option
@@ -468,15 +498,19 @@ def cli(int_param):
 Notice how the default search pattern gets limited to files with a `.json` extension:
 
 ```{click:run}
-:emphasize-lines: 8
+---
+emphasize-lines: 8
+---
 result = invoke(cli, args=["--help"])
 assert "*.json]" in result.stdout
 ```
 
 This also works with a subset of formats:
 
 ```{click:example}
-:emphasize-lines: 8
+---
+emphasize-lines: 8
+---
 from click import command, option, echo
 
 from click_extra import config_option
@@ -490,7 +524,9 @@ def cli(int_param):
 ```
 
 ```{click:run}
-:emphasize-lines: 8
+---
+emphasize-lines: 8
+---
 result = invoke(cli, args=["--help"])
 assert "*.{ini,yaml,yml}]" in result.stdout
 ```
@@ -500,7 +536,9 @@ assert "*.{ini,yaml,yml}]" in result.stdout
 Remote URL can be passed directly to the `--config` option:
 
 ```{code-block} shell-session
-:emphasize-lines: 1
+---
+emphasize-lines: 1
+---
 $ my-cli --config "https://example.com/dummy/configuration.yaml" subcommand
 dummy_flag    is True
 my_list       is ('point 1', 'point #2', 'Very Last Point!')