Changelog Markdown is lossy: index.md.xml serves HTML, and index.md flattens tabs, captions, and callouts

Abierto
#33,908 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
4/5
Tiempo estimado
3-5 días
Aptitud para principiantes
64/100
Tipo de issue
Error
Claridad
Bastante claro
Estado de actividad
Activo
Stack tecnológico
markdown, typescript

Línea de trabajo

Start with getEntryMarkdown and the changelog-related code in src/util/changelog.ts and src/util/rss.ts, then inspect the route that serves index.md.xml. Read renderEntryAsMarkdown on nimbus main at commit 3f1f58d and reproduce the listed feed and post examples. Done means the feed contains Markdown and post output preserves labels, callouts, code samples, package-manager flags, and removes decorative glyphs.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

engineering
Example URL(s)
Actual Behavior
  1. /changelog/rss/index.md.xml serves HTML. index.md.xml.ts calls the same getRSSItems() as the HTML feed; the header of src/util/changelog.ts notes the Markdown variant was not ported to Nimbus.
  2. Post index.md output (Markdown for Agents conversion of the rendered HTML) loses component meaning: package-manager tabs become npmyarnpnpmbun plus four unlabeled code blocks, code captions become *src/index.jsjs*, JS/TS examples appear twice unlabeled, callouts become a bare Note line, and links keep the ↗︎ glyph.
Expected Behavior

The Markdown feed contains Markdown, and post Markdown keeps component meaning: one labeled command block, one TypeScript sample, labeled callouts, no decorative glyphs.

Additional information

getEntryMarkdown from @cloudflare/nimbus-docs/runtime produces clean Markdown for these posts and could back index.md.xml (about 40 lines in src/util/changelog.ts, src/util/rss.ts, and the route; I can open a PR). On nimbus main (3f1f58d), renderEntryAsMarkdown has three gaps that affect it:

  • top-level MDX import lines are emitted verbatim
  • :::note admonitions stay as raw directive syntax
  • <PackageManagers … global /> drops the global flag (npm i cf instead of npm install --global cf)
Lenguaje dominante
MDX
Estrellas
5.4k
Forks
17.3k
Merge medio
1 d 20 h
PR fusionados (30 d)
525

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 cloudflare/cloudflare-docs

Todos los issues de cloudflare/cloudflare-docs

Issues similares

Más issues de Documentation

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.