CSV to Markdown

Що таке конвертація CSV у Markdown?

Перетворення CSV на Markdown-таблицю — поширене завдання розробника. CSV (Comma-Separated Values) зберігає табличні дані у вигляді простого тексту: кожен рядок — окремий запис, а поля розділяються символом-роздільником, наприклад комою або табуляцією. Це формат експорту за замовчуванням для електронних таблиць, SQL-клієнтів та інструментів аналітики. CSV-файли компактні й прості у генерації, але не мають вбудованих засобів для керування відображенням даних. CSV-файл, відкритий у текстовому редакторі, — це суцільний масив рядків, розділених комами: зчитуваний для машини, але незручний для сприйняття людиною.

Markdown-таблиці розв'язують цю проблему читабельності. Вони визначені специфікацією GitHub Flavored Markdown (GFM) і підтримуються GitHub, GitLab, Bitbucket, Notion, Obsidian та генераторами статичних сайтів Hugo і Jekyll — де б не оброблявся Markdown, вони відображаються як чисті HTML-таблиці. Синтаксис використовує символи вертикальної риски для розділення стовпців і обов'язковий рядок-роздільник із тире між рядком заголовка та рядками тіла таблиці.

Конвертація CSV у Markdown-таблицю означає обгортання кожного рядка в синтаксис із вертикальними рисками та вставку рядка-роздільника після заголовка. Перший рядок CSV стає заголовком таблиці, кожен наступний — рядком тіла. Це потрібно щоразу, коли ви вставляєте структуровані дані у README, опис pull request, сторінку вікі або будь-яку систему документації Markdown.

Навіщо використовувати цей інструмент?

Цей конвертер парсить CSV у браузері, миттєво формує Markdown-таблицю і ніколи не передає ваші дані на сервер.

Сценарії використання CSV to Markdown

Довідник синтаксису Markdown-таблиць

Markdown-таблиці відповідають специфікації GitHub Flavored Markdown (GFM). Кожна таблиця потребує рядка заголовка, рядка-роздільника та одного або більше рядків тіла. Рядок-роздільник керує вирівнюванням стовпців.

CSV проти Markdown-таблиці

Обидва формати представляють табличні дані у вигляді простого тексту. CSV — для машин і конвеєрів обробки даних; Markdown-таблиці — для людей, що читають документацію.

Приклади коду

Наведені нижче приклади показують, як програмно конвертувати CSV у Markdown-таблицю різними мовами. Кожен приклад формує коректну GFM-таблицю.

const csv = `name,age,city
Alice,30,Berlin
Bob,25,Tokyo`

const [headerLine, ...rows] = csv.trim().split('\n')
const headers = headerLine.split(',')

const separator = '| ' + headers.map(() => '---').join(' | ') + ' |'
const headerRow = '| ' + headers.join(' | ') + ' |'
const bodyRows = rows.map(row =>
  '| ' + row.split(',').join(' | ') + ' |'
)

const markdown = [headerRow, separator, ...bodyRows].join('\n')
// → | name | age | city |
// → | --- | --- | --- |
// → | Alice | 30 | Berlin |
// → | Bob | 25 | Tokyo |

import csv
import io

csv_string = """name,age,city
Alice,30,Berlin
Bob,25,Tokyo"""

reader = csv.reader(io.StringIO(csv_string))
rows = list(reader)
headers = rows[0]

lines = []
lines.append('| ' + ' | '.join(headers) + ' |')
lines.append('| ' + ' | '.join('---' for _ in headers) + ' |')
for row in rows[1:]:
    lines.append('| ' + ' | '.join(row) + ' |')

print('\n'.join(lines))
# → | name | age | city |
# → | --- | --- | --- |
# → | Alice | 30 | Berlin |
# → | Bob | 25 | Tokyo |

# With pandas (one-liner)
import pandas as pd
df = pd.read_csv(io.StringIO(csv_string))
print(df.to_markdown(index=False))

package main

import (
	"encoding/csv"
	"fmt"
	"strings"
)

func main() {
	input := "name,age,city\nAlice,30,Berlin\nBob,25,Tokyo"
	r := csv.NewReader(strings.NewReader(input))
	records, _ := r.ReadAll()

	headers := records[0]
	var lines []string

	lines = append(lines, "| "+strings.Join(headers, " | ")+" |")
	sep := make([]string, len(headers))
	for i := range sep {
		sep[i] = "---"
	}
	lines = append(lines, "| "+strings.Join(sep, " | ")+" |")

	for _, row := range records[1:] {
		lines = append(lines, "| "+strings.Join(row, " | ")+" |")
	}

	fmt.Println(strings.Join(lines, "\n"))
	// → | name | age | city |
	// → | --- | --- | --- |
	// → | Alice | 30 | Berlin |
	// → | Bob | 25 | Tokyo |
}

# Using Miller (mlr) — convert CSV to Markdown table
mlr --icsv --omarkdown cat data.csv
# → | name | age | city |
# → | --- | --- | --- |
# → | Alice | 30 | Berlin |

# Using csvtomd (pip install csvtomd)
csvtomd data.csv

# Using pandas in a one-liner
python3 -c "
import pandas as pd, sys
print(pd.read_csv(sys.argv[1]).to_markdown(index=False))
" data.csv

Часті запитання