Attribute 'compatible'

[naokazuterada]

Purpose

Provide end users with easy configuration of configuration for various sites(GitHub, Gitlab, Bitbucket).

How important it is

Current configurations are complex.

Ref: https://github.com/naokazuterada/MarkdownTOC/issues/139#issuecomment-486988479

Ideal implementation

<!-- MarkdownTOC compatibility="github" -->

is shorthand for

<!-- MarkdownTOC autolink="true" bracket="round" lowercase="only_ascii" -->

Notes

• [ ] Enable to override if other attributes follow

<!-- MarkdownTOC compatibility="github" levels="1,2,3" -->

• [ ] compatibility should contain not only 'attributes' setting but also id_replacements setting.

[tajmone]

GitHub Settings

@naokazuterada, today I've encounted some more edge-case headings that required customizing my MarkdownTOC settings:

• Remove trailing hyphens.
• Remove consecutive hyphens (this must be the very last).

    {
      // remove trailing hyphens:
      "pattern": "\\-+$",
      "replacement": ""
    },
    {
      // reduce consecutive hyphens:
      "pattern": "\\-{2,}",
      "replacement": "-"
    },

Examples of headings that require this patterns:

heading	GitHub anchor
# Lang ( Go )	#lang-go

without the above substitutions, the generated link would be #lang--go--.

Possibly there might still be some edge-cases lurking in the dark — which only confirms that managing manual settings for all Git services is quite cumbersome, whereas having server configurations is going to make life much easier, especially with package updates fixing any new uncovered incompatiblity edge case.

[naokazuterada]

@tajmone Thank you for the reference case. It was very valuable. I do not know that it will be possible with my effort to support all services, but I understood the importance of this feature. It would be able to obtain the required function by making the algorithm of ID conversion extensible and updating it little by little in the future. I agree. I take this into my TODO list. 👍