Make `myst_heading_anchors` default to 3

[wlach]

Context

Currently you need to manually enable heading anchors by setting myst_heading_anchors to a default value in your configuration file: https://myst-parser.readthedocs.io/en/latest/syntax/optional.html#auto-generated-header-anchors

I'm wondering why we don't do this by default? It seems like a very useful feature. I see @chrisjsewell originally added this in https://github.com/executablebooks/MyST-Parser/pull/249 but there was little discussion.

Proposal

Give myst_heading_anchors a default value of 3.

Tasks and updates

No response

[welcome[bot]]

Thanks for opening your first issue here! Engagement like this is essential for open source projects! :hugs:
If you haven't done so already, check out EBP's Code of Conduct. Also, please try to follow the issue template as it helps other community members to contribute more effectively.
If your issue is a feature request, others may react to it, to raise its prominence (see Feature Voting).
Welcome to the EBP community! :tada:

[chrisjsewell]

Heya, because it could lead to many unexpected reference name clashes, and potentially slower build times, for a feature that not everyone wants/needs to use. I feel that having it as an optional configuration, serves the most people the best

[wlach]

Heya, because it could lead to many unexpected reference name clashes, and potentially slower build times, for a feature that not everyone wants/needs to use. I feel that having it as an optional configuration, serves the most people the best

That's fair, do you think we could mention this in the docs?