Отличный README.md — это разница между успешным проектом с открытым исходным кодом и заброшенным. И один из лучших способов представить документацию по API, сравнение функций или параметры конфигурации — использовать таблицы.
К сожалению, стандартный Markdown не упрощает работу с таблицами.
Борьба за таблицу уценки
Написание таблицы Markdown вручную выглядит так:
```уценка | Недвижимость | Тип | Описание | |---|---|---| | идентификатор | строка | Уникальный идентификатор | | тайм-аут | номер | Время в миллисекундах | ```
Если вы добавите длинное описание в одну строку, вся таблица в редакторе кода станет визуально искаженной, что сделает ее невероятно трудной для обслуживания и чтения.
Визуальная генерация
Самый эффективный рабочий процесс — использовать визуальную сетку. С помощью нашего [Генератор таблиц уценки](/en/markdown-table-generator) вы можете вводить свой контент в интерфейс, похожий на электронную таблицу.
Вы можете добавлять столбцы, удалять строки и печатать естественным образом. Как только вы закончите, инструмент мгновенно сгенерирует идеально разнесенный и четко отформатированный синтаксис Markdown. Вы просто копируете его и вставляете в свой README.
Перестаньте бороться с вертикальной чертой (`|`) и тире и начните создавать таблицы визуально!