Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

Guide: how to make a table in Markdown

Cerrado
  • ¿Algo no está bien?
#364 2 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

@Saifjafri212213 ya está trabajando en esto.

Desde el 27/10/2026.

  • #365 de @Saifjafri212213 — fusionado

Evaluación

Dificultad
3/5
Tiempo estimado
1-2 días
Aptitud para principiantes
50/100
Tipo de issue
Documentación
Claridad
Bien especificado
Estado de actividad
Activo
Stack tecnológico
markdown, nextjs, typescript
Área
content, documentation

Línea de trabajo

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.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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.

Lenguaje dominante
TypeScript
Estrellas
1
Forks
9
Merge medio
7 h 46 min
PR fusionados (30 d)
186

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de codercops/toolbelt

Todos los issues de codercops/toolbelt

Issues similares

Más issues de TypeScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.