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 小时 46 分钟
- 30 天内合并 PR
- 186
环境准备
- 没有 Dockerfile 或 Docker Compose 文件
- 有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
codercops/toolbelt 的其他 Issue
-
Text Case Converter: show how identifiers are split into words可能已有人在做 @srikar-naidu 于 1 天前认领。 未关闭enhancement hacktoberfest
codercops/toolbelt#409 · 2 条评论 · 已指派 1 人 ·
维护者通常 1 天内回复
-
Base64 Decoder: show precise errors for invalid characters and padding可能已有人在做 @srikar-naidu 于 1 天前认领。 未关闭enhancement hacktoberfest
codercops/toolbelt#406 · 2 条评论 · 已指派 1 人 ·
维护者通常 1 天内回复
-
Regex Tester: add next/previous match navigation可能已有人在做 @kachamsiddarth 于 1 天前认领。 未关闭enhancement hacktoberfest
codercops/toolbelt#380 · 5 条评论 · 已指派 1 人 ·
维护者通常 1 天内回复
-
hacktoberfest
难度 1/5 1 小时以内 新手友好度 1/100
codercops/toolbelt#101 · 17 条评论 ·
维护者通常 1 天内回复
-
[admin] Quarterly content-refresh routine可能重新可做 @anurag629 于 111 天前认领，目前没有进行中的 PR。 未关闭admin-only seo
codercops/toolbelt#47 · 已指派 1 人 ·
维护者通常 1 天内回复
查看 codercops/toolbelt 的全部 Issue
相似的 Issue
-
fix(worker): keep normal prepare waiting states failure-free可能已有人在做 @LichKing-2234 今天认领。 未关闭agent:codex priority:P1
难度 2/5 1-3 小时 新手友好度 72/100
AgoraIO-Extensions/agent-infra#3745 ·
维护者通常 1 天内回复
-
The five-line work window can drop its oldest line: the per-line byte share ignores the JSON framing可能已有人在做 @Eapp1e 今天认领。 未关闭
难度 2/5 1-3 小时 新手友好度 84/100
makecindy/cindy#7973 · 1 条评论 ·
维护者通常 1 天内回复
-
community first-timers-only good first issue hacktoberfest help wanted low hanging fruit up-for-grabs
难度 1/5 1 小时以内 新手友好度 78/100
lingdojo/kana-dojo#33337 · 1 条评论 · 5 个 reaction ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 76/100
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 78/100
code-yeongyu/senpi#4917 · 1 条评论 ·
维护者通常 1 天内回复