Support Markdown tables in notes and guides

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

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

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

評価

難易度
3/5
見積もり時間
1〜2日
初心者へのやさしさ
78/100
issue の種類
機能追加
明瞭さ
明確に書かれている
活発さ
活発
技術スタック
next.js, react, typescript
領域
content

調査の方向性

Start with SAFE_MDX_OPTIONS in src/lib/mdx-safe.ts and NoteBody in src/components/note-body.tsx to trace how notes and guides are rendered and sanitized. Then review src/components/mdx-components.tsx, src/lib/mdx-safe.test.ts, and the content guide. Done when tables compile, raw HTML in cells remains rejected, wide tables scroll within their container on phones, and the guide documents the syntax.

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

説明

enhancement help wanted

Problem

Notes and guides cannot use Markdown tables. The content guide says: "Tables need a plugin that is not installed yet, so avoid them for now." Tables are useful in study notes, for example to compare data structures or complexity.

Where it happens

Notes (/dashboard/...) and guides (/guides/...) render through NoteBody in src/components/note-body.tsx, using SAFE_MDX_OPTIONS from src/lib/mdx-safe.ts. That file also rejects raw HTML, JSX, and {expressions} for safety.

Suggested approach

  1. Add remark-gfm to remarkPlugins in SAFE_MDX_OPTIONS, keeping remarkRejectJsx.
  2. Style tables in src/components/mdx-components.tsx. Wide tables must scroll inside their own container on a phone instead of widening the page.
  3. Add tests to src/lib/mdx-safe.test.ts: a table compiles, and raw HTML inside a table cell is still rejected.
  4. Update the content guide to explain table syntax and remove the "avoid tables" line.

remark-gfm also enables strikethrough, task lists, footnotes, and autolinks. Mention in the pull request which of these you checked.

Check your change

npm run lint
npm run typecheck
npm test
npm run build
npm run e2e

Please comment with your plan before starting, since this touches the content security pipeline.

主要言語
TypeScript
スター
1
フォーク
1
平均マージ
8時間 58分
マージ済み PR(30日)
37

環境構築

はじめの一歩

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

procoderji-com/procoderji のほかの issue

procoderji-com/procoderji の issue をすべて見る

似ている issue

TypeScript の issue をもっと見る

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

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