Definitive "document mode"

[Lemmingh]

Background

Here are two stories.

Internal disorder is blocking new features and bug fixes

I tried to draft a "plugin system" (substantially a huge architecture change) earlier this year, but couldn't make any progress due to mismatches between components.

The "plugin system" was intended to fix some bugs discussed in:

• 🐛 Rewrite heading processing #877
• Math expressions are recognized as setext headings #911
• Wrong VS Code slugify: Should parse heading by the same markdown-it engine as VS Code's #970

We still have to deal with different Markdown flavors

Although we declare our focus on CommonMark and GFM, the reality of Markdown is wild. There are so many syntax extensions on major platforms that we cannot simply ignore them.

Examples:

• GitLab: Syntax decorations for code span add unwanted boxes to GitLab inline math #713
• Bitbucket: Incorrect preview of nested bulleted list #1044

Proposal

A new setting, probably called "document mode" (document.mode), governing many other settings.

Let's begin with:

{
    "markdown.extension.document.mode": {
        "type": "string",
        "default": "github",
        "markdownDescription": "Lock other settings to meet a specific platform. If you need to change each setting individually, please use `vscode`. See the [docs](https://markdown-all-in-one.github.io/docs/guide/document-mode.html) for details.",
        "enum": [
            "github",
            "commonmark",
            "gitlab",
            "vscode"
        ],
        "enumDescriptions": [
            "GitHub",
            "CommonMark",
            "GitLab",
            "Visual Studio Code"
        ]
    }
}

[yzhang-gh]

Looks like a set pre-defined profiles.

Lock other settings to meet a specific platform. If you need to change each setting individually, please use vscode. See the docs for details.

Then it could be custom.

[Lemmingh]

We can also contribute to the language status indicator (microsoft/vscode#129037) eventually.

[Lemmingh]

Additional context:

Looks like we initially talked about the concept "definitive setting" at #962 (comment)