Enhancement: put variable names between backticks

[amedee]

Description

I always run Prettier on auto-generated Markdown files, including those made by ansible-doctor. Prettier is opiniated and replaces double underscores (__) in variable names with Markdown bold (**) in role READMEs generated by ansible-doctor. Prettier can NOT be configured to not replace __ with **.

Example:

# Original variable in defaults/main.yml
imapsync__logrotate__dependent_config

Generated README.md by ansible-doctor:

## Table of contents

- [Requirements](#requirements)
- [Default Variables](#default-variables)
  - [imapsync__logrotate__dependent_config](#imapsync__logrotate__dependent_config)

...

## Default Variables

### imapsync__logrotate__dependent_config

README.md after Prettier:

## Table of contents

- [Requirements](#requirements)
- [Default Variables](#default-variables)
  - [imapsync**logrotate**dependent_config](#imapsync__logrotate__dependent_config)

...

## Default Variables

### imapsync**logrotate**dependent_config

Impact

• TOC links break (#imapsync__logrotate__dependent_config no longer matches)
• Markdown linters (MD051) fail
• Variable names are misrepresented

Suggested fix

To render variable names literally, wrap them in backticks. Prettier will then not touch them.

## Table of contents

- [Requirements](#requirements)
- [Default Variables](#default-variables)
  - [`imapsync__logrotate__dependent_config`](#imapsync__logrotate__dependent_config)

...

## Default Variables

### `imapsync__logrotate__dependent_config`

Side effects

The variable names will be in a monospaced font in the rendered Markdown. Personally I actually see that as an improvement.

Steps to reproduce

1. Create a variable with double underscores in a role.
2. Run ansible-doctor to generate README.md.
3. Observe __.
4. Run npx prettier to prettify README.md.
5. Observe replacement of __ with **.
6. Run ansible-doctor again to generate README.md.
7. Observe __.
8. Manually wrap imapsync__logrotate__dependent_config in backticks.
9. Run npx prettier to prettify README.md.
10. Observe __.

Minimal YAML snippet

# roles/test_role/defaults/main.yml
imapsync__logrotate__dependent_config:
  - filename: imapsync
    log: /var/log/imapsync.log

Environment

• ansible-doctor version: 8.2.0
• OS: Ubuntu 24.04.3 LTS

[amedee]

Low priority. I found a workaround that works for me, for now.

I was able to rename my variable from imapsync__logrotate__dependent_config to imapsync_logrotate__dependent_config (first double underscore to single underscore).

This is rendered by ansible-doctor as imapsync_logrotate\_\_dependent_config in Markdown, and that is not touched by Prettier.