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

オープン
#33,908 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度
4/5
見積もり時間
3〜5日
初心者へのやさしさ
64/100
issue の種類
バグ
明瞭さ
おおむね明確
活発さ
活発
技術スタック
markdown, typescript
領域
documentation

調査の方向性

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.

索引モデルが issue の本文から書いたものです。

説明

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)
主要言語
MDX
スター
5.4k
フォーク
17.3k
平均マージ
1日 20時間
マージ済み PR(30日)
525

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

cloudflare/cloudflare-docs のほかの issue

cloudflare/cloudflare-docs の issue をすべて見る

似ている issue

Documentation の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。