Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

Guide: how to make a table in Markdown

Đã đóng
  • Có gì không ổn?
#364 2 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

@Saifjafri212213 đang làm issue này rồi.

Từ ngày 27/10/2026.

  • #365 của @Saifjafri212213 — đã merge

Đánh giá

Độ khó
3/5
Thời gian dự kiến
1-2 ngày
Mức phù hợp với người mới
50/100
Loại issue
Tài liệu
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
markdown, nextjs, typescript
Lĩnh vực
content, documentation

Hướng nghiên cứu

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.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

documentation good first issue hacktoberfest seo

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 .md files 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/ and lib/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 publishedAt is the day the guide goes live
  • npm run lint && npm run test && npm run build passes

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.

Ngôn ngữ chính
TypeScript
Star
1
Fork
9
Merge trung bình
7 giờ 54 phút
Pull request đã merge (30 ngày)
165

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của codercops/toolbelt

Tất cả issue của codercops/toolbelt

Issue tương tự

Thêm issue về TypeScript

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.