Guide: how to make a table in Markdown
メンテナーはふだん 1 日以内に返信
評価
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 初心者へのやさしさ
- 50/100
- issue の種類
- ドキュメント
- 明瞭さ
- 明確に書かれている
- 活発さ
- 活発
- 技術スタック
- markdown, nextjs, typescript
- 領域
- content, documentation
調査の方向性
Start with lib/guides.ts (the GUIDES entry) and the existing guide routes in app/guides/format-and-validate-json/ as a template, then read lib/markdown-preview.ts and app/(tools)/markdown-preview/ to confirm the breaks: true behaviour and which fence languages are highlighted. Done means a new app/guides/<slug>/ route with page.tsx and opengraph-image.tsx, an accurate guide that links to /markdown-preview, and npm run lint && npm run test && npm run build passing.
索引モデルが issue の本文から書いたものです。
説明
Context
Part of the SEO growth initiative (#18): Phase 2: Coverage engine (guides and internal linking).
Searches like "markdown table syntax" and "how to make a table in markdown" map directly to the Markdown Live Preview.
What to do
- Write a genuinely useful, original guide (examples, a table, or screenshots) that answers the query in the first two sentences.
- Use clear H2/H3 that match sub-questions, short paragraphs, and lists.
- Link to the Markdown Live Preview (
/markdown-preview) and to related guides. - Topics worth covering: the header row and the separator row, column alignment with colons, escaping a pipe inside a cell, inline code and links in cells, and the other GitHub-flavored Markdown pieces people reach for next (task lists, strikethrough, fenced code blocks with a language, autolinks).
- Note what is specific to the preview: it renders single line breaks as
<br>(breaks: true), the way GitHub comments do but GitHub's.mdfiles don't, and it highlights fenced code in markup, CSS, JavaScript, TypeScript, JSON and Bash. - Check every statement about the tool against its code (
app/(tools)/markdown-preview/andlib/markdown-preview.ts) and every syntax rule against the GitHub Flavored Markdown spec. Guides are reviewed line by line for accuracy.
Where
A new entry in GUIDES (lib/guides.ts) and a route under app/guides/<slug>/ (page.tsx and opengraph-image.tsx), set up the same way as the existing guides in app/guides/format-and-validate-json/ and app/guides/test-regex-in-javascript/. The "Add a guide" section of the README lists the steps.
Acceptance criteria
- Guide published, answers the query up top, and links to the Markdown Live Preview
- Everything it says about the tool matches what the tool does today, and
publishedAtis the day the guide goes live -
npm run lint && npm run test && npm run buildpasses
Notes
Want to work on this? Comment below and I'll assign it to you. Please take one issue at a time, branch off develop, and open your PR against develop with Closes #364 in the description.
- 主要言語
- TypeScript
- スター
- 1
- フォーク
- 9
- 平均マージ
- 7時間 54分
- マージ済み PR（30日）
- 165
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートあり
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
codercops/toolbelt のほかの issue
-
UUID generator's v7 batch comes out in random order instead of time order対応中かも @omisha123 が 5 日前に担当しました。 オープンbug good first issue hacktoberfest
codercops/toolbelt#316 · コメント 3 件 · 担当者 1 名 ·
メンテナーはふだん 1 日以内に返信
-
Guide: how to convert a Unix timestamp to a date and back対応中かも @varun-pahuja が 5 日前に担当しました。 オープンdocumentation good first issue hacktoberfest seo
codercops/toolbelt#275 · コメント 3 件 · 担当者 1 名 ·
メンテナーはふだん 1 日以内に返信
-
hacktoberfest
難易度 1/5 1時間未満 初心者へのやさしさ 1/100
codercops/toolbelt#101 · コメント 6 件 ·
メンテナーはふだん 1 日以内に返信
-
[admin] Quarterly content-refresh routine再び着手できるかも @anurag629 が 110 日前に担当しましたが、オープン中のプルリクエストはありません。 オープンadmin-only seo
codercops/toolbelt#47 · 担当者 1 名 ·
メンテナーはふだん 1 日以内に返信
-
[admin] Repurpose guides to dev communities and social再び着手できるかも @anurag629 が 110 日前に担当しましたが、オープン中のプルリクエストはありません。 オープンadmin-only seo
codercops/toolbelt#44 · 担当者 1 名 ·
メンテナーはふだん 1 日以内に返信
codercops/toolbelt の issue をすべて見る
似ている issue
-
community first-timers-only good first issue hacktoberfest help wanted low hanging fruit up-for-grabs
難易度 1/5 1時間未満 初心者へのやさしさ 82/100
lingdojo/kana-dojo#33286 · コメント 1 件 · リアクション 5 件 ·
メンテナーはふだん 1 日以内に返信
-
friction
難易度 1/5 1時間未満 初心者へのやさしさ 77/100
kentcdodds/kody#4499 ·
-
bug
難易度 2/5 1〜3時間 初心者へのやさしさ 76/100
hemilabs/ui-monorepo#2605 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
メンテナーはふだん 6 日以内に返信
-
build.yml: macOS arm64 DMG fails, cargo missing on the macos-26 runner image対応中かも このイシューにリンクされたプルリクエストがオープン中、またはマージ済みです。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
getopenscreen/openscreen#1423 ·
メンテナーはふだん 1 日以内に返信