Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

Is it possible to escape HTML so I can use MDX in descriptions?

Abierto
  • ¿Algo no está bien?
#993 10 comentarios 1 reacción 1 asignado Ver en GitHub

Los mantenedores suelen responder en 2 días

@sserrata ya está trabajando en esto.

Desde el 22/11/2024.

Evaluación

Este issue todavía no se ha evaluado.

Descripción

reviewing :eyes:

I want to reuse a common component (MDX) in several areas of my OpenAPI spec as shown in the example below.

The <b> tags are getting passed through, but the < in <UnderConstruction /> is getting transformed to &lt; UnderConstruction />, which of course makes the component not render as desired. And <blink> doesn't work, sadly. So it seems like maybe there's a whitelist of allowed tags.

Is there an escape hatch if I want to get crazy and put MDX components in my OpenAPI description fields?

api-keys-delete:
  post:
    summary: Delete API Keys
    description: |
      Delete one or more API keys by their internal ID.

      <blink>Hello</blink>, <b>world</b>!

      import UnderConstruction from '../partials/\_under-construction.mdx'

      <UnderConstruction />

Gets translated to this MDX:

<MethodEndpoint
  method={"post"}
  path={"/api_keys/delete_api_keys"}
  context={"endpoint"}
>
</MethodEndpoint>


Delete one or more API keys by their internal ID.

<blink&gt;Hello</blink&gt;, <b>world</b>!

import UnderConstruction from '../partials/\_under-construction.mdx'

&lt;UnderConstruction />
Lenguaje dominante
TypeScript
Estrellas
1.1k
Forks
317
Merge medio
1 d 14 h
PR fusionados (30 d)
17

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de PaloAltoNetworks/docusaurus-openapi-docs

Todos los issues de PaloAltoNetworks/docusaurus-openapi-docs

Issues similares

Más issues de TypeScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.