facebook / facebook/docusaurus

Remove legacy admonition keywords

Abierto
#9,307 9 comentarios 0 reacciones 0 asignados Ver en GitHub
domain: markdown proposal
Lenguaje dominante
TypeScript
Estrellas
66.2k
Forks
10k
Merge medio
1 d 3 h
PR fusionados (30 d)
52

Descripción

### 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.

Guía de contribución

Abrir la guía de contribución

Evaluación

Este issue todavía no se ha evaluado.

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.