facebook / facebook/docusaurus

Remove legacy admonition keywords

未关闭
#9,307 9 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看
domain: markdown proposal
主要语言
TypeScript
星标
66.2k
派生
10k
平均合并
1 天 3 小时
30 天内合并 PR
52

描述

### Have you read the Contributing Guidelines on issues?

- [X] I have read the [Contributing Guidelines on issues](https://github.com/facebook/docusaurus/blob/main/CONTRIBUTING.md#issues).

### Motivation

We historically have admonition keyword "aliases" that we don't even document since v2.0.

![CleanShot 2023-09-14 at 17 59 26](https://github.com/facebook/docusaurus/assets/749374/c670264a-b45f-4055-aa52-d444fc25c7b8)

Those came from an old v2 dependency: https://github.com/elviswolcott/remark-admonitions

In Docusaurus v4 is time to remove them officially and throw an error for sites that still use them.

Note: in Docusaurus v3 we made `:::warning` the official admonition, and `:::caution` an alias to remove in v4 (see https://github.com/facebook/docusaurus/issues/7558)

**EDIT**: maybe we should have some kind of `siteConfig.markdown.admonitions` config and probably let users define their own set of directive/icon/color/label without requiring swizzling anything?

### Self-service

- [X] I'd be willing to do some initial work on this proposal myself.

贡献指南

打开贡献指南

评估

这个 Issue 还没有评估数据。

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。