Как сделать таблицу в md файле

Обновлено: 04.07.2024

Markdown - это язык разметки, используемый для форматирования документов всех типов, созданный Джоном Грубером и Аароном Шварцем в 2004 году, сегодня это один из самых популярных языков среди программистов.

photo Определение Markdown из Википедии

ПРИМЕЧАНИЕ: язык разметки - это язык, который использует tags или символы для применения стилизации к содержимому. Самыми популярными языками разметки в мире являются HTML, XML и Markdown.

На изображении ниже вы можете увидеть файл, отформатированный с помощью Markdown в текстовом редакторе Sublime Text.

photo Пример форматирования Markdown на Sublime Text

Файл Markdown или MD состоит из простого текста, прост для понимания и не содержит всей этой разметки HTML, загрязняющей содержимое.

С помощью Markdown вы можете добавить к документу форматирование с помощью разметки символов.

Важно отметить, что формат Markdown отличается от формата, используемого некоторыми редакторами WYSIWYG .

ПРИМЕЧАНИЕ: WYSIWYG - это сокращение от What You See Is What You Get . В основном форматирование контента происходит в реальном времени, то есть видно сразу. Чтобы узнать больше, вы можете обратиться к этой статье Википедии.

Например, в Microsoft Word, который является редактором WYSIWYG, форматирование текста происходит при выборе определенного содержимого и нажатии определенной кнопки, комбинации клавиш или некоторого пункта меню.

photo Окно Microsoft Word - WYSIWYG

Эти символы используются процессором Markdown, чтобы узнать, какие слова / фразы следует форматировать при преобразовании файла в HTML.

Например, ** Я хочу, чтобы этот текст был полужирным ** и _этот текст курсивом_ .

Слишком запутались? Немного упростим.

Когда вы окружаете контент двумя звездочками ** , вы выделяете его жирным шрифтом, во втором примере мы используем подчеркивание _ , чтобы применить курсив.

Как редактировать файл Markdown

Файл Markdown - это не что иное, как текст , поэтому для этой задачи достаточно любого простого текстового редактора.

photo Редактирование документа Markdown в Notepad.

Однако интересно принять во внимание:

Редактор, позволяющий конвертировать наш документ Markdown в другой формат.
Редактор, который может выделять синтаксис Markdown.
Редактор, показывающий преобразование в HTML в реальном времени

Хорошая новость в том, что:

Существует несколько приложений Markdown для различных операционных систем, включая Windows, Linux, Android и даже iOS.
Когда дело доходит до Web, все становится еще лучше, несколько сайтов предлагают бесплатные приложения Markdown для редактирования ваших документов online, и, что лучше всего, многие имеют конвертер в реальном времени, то есть, когда вы вводите приложение, уже конвертирующееся в HTML .

photo Параллельные текстовые редакторы: Notepad ++, Sublime Text & Visual Studio Code.

ПРИМЕЧАНИЕ: стоит помнить, что форматирование Markdown чрезвычайно простое, поэтому документ, отформатированный на этом языке, остается читаемым.

Markdown против WYSIWYG

Если редактор WYSIWYG (который предлагает форматирование в реальном времени) чрезвычайно удобен, зачем мне использовать Markdown?

photo Сравнение форматирования Markdown и форматирования WYSIWYG.

Если я использую редактор WYSIWYG, я могу нажать кнопку и получить желаемое форматирование, почему я собираюсь печатать документ с разметкой Markdown?

Давайте посмотрим на некоторые причины использования Markdown:

Практика

Лучший способ учиться - это практиковаться!

Интересно, что для изучения синтаксиса языка у вас есть редактор Markdown.

Самый быстрый способ начать практиковать Markdown - использовать редакторы online. С приложениями Web вам не нужно ничего скачивать, просто зайдите на сайт и начните редактировать файл md .

photo Редакторы online, StackEdit, Dillinger и Editor.md

ПРИМЕЧАНИЕ: откройте один из редакторов online на другой вкладке браузера, чтобы обучить синтаксис Markdown в реальном времени.

StackEdit

StackEdit - одно из наиболее полных приложений. В дополнение к редактору он также предоставляет конвертер в реальном времени, который отображает HTML на правой панели.

photo Интерфейс редактора Web Markdown StackEdit

См. Дополнительную информацию о StackEdit в разделе инструментов.

Dillinger

Dillinger имеет очень простой интерфейс, но предлагает несколько вариантов редактирования документа Markdown. Помимо преобразования в реальном времени, вы также можете экспортировать файл в форматы HTML и PDF.

photo Интерфейс редактора Web Markdown Dillinger

Для получения дополнительной информации о Dillinger [a1] нажмите здесь.

Editor.md (Markeditor)

Editor.md - это инструмент с открытым исходным кодом, в нем есть преобразователь MD для HTML в реальном времени и кнопки, которые позволяют создавать элемент Markdown одним щелчком мыши.

photo Интерфейс редактора Web Markdown Editor.md

А потом?

Набравшись опыта, вы можете загрузить приложение для своей операционной системы и приступить к редактированию документов локально.

В разделе "Инструменты a1]" вы найдете обширный список приложений с инструкциями по их использованию и информацией о совместимости с элементами Markdown.

Что ж, теперь, когда у вас есть редактор для практики Markdown, давайте разберемся, как работает преобразование из одного формата в другой.

Как конвертировать файл Markdown

Давайте разберемся с процедурой, используемой приложениями Markdown для преобразования вашего файла md в другой формат, обычно HTML или PDF.

photo Как конвертировать файл Markdown

Простота Markdown

Как определить файл Markdown? По расширению, правильно? Обычно md или markdown .

photo Расширения файлов Markdown

Файл Markdown представляет собой простой текст, не имеет форматирования, не является зашифрованным и, тем более, скомпилированным.

ПРИМЕЧАНИЕ: Эта простота позволяет программам анализировать ваш текст на предмет символов, которые идентифицируют элементы Markdown.

Несколько приложений Markdown, помимо редактора, также имеют встроенный конвертер. Конвертер отвечает за перевод синтаксиса Markdown в другой формат.

photo Файлы, созданные из форматированного Markdown

Как происходит преобразование

Конвертер Markdown использует Parser для сканирования своего содержимого на предмет маркировки, совместимой с Markdown; При нахождении совместимой разметки Parser проверяет, есть ли совпадение в выходном формате, например tag HTML, который производит такое же форматирование.

Ниже вы можете увидеть примерную таблицу соответствия между маркером Markdown и tag HTML.

photo Таблица сравнения синтаксиса Markdown и HTML.

Обратите внимание, что формат HTML является одним из наиболее часто используемых для преобразования Markdown. Ваш файл, преобразованный в HTML, можно просмотреть в любом браузере Web, таком как Google Chrome, Mozilla Firefox и Microsoft Edge.

На изображении ниже вы можете увидеть упрощенную версию процесса конвертации.

photo Простая схема создания крышки между Markdown и HTML.

ПРИМЕЧАНИЕ: важно отметить, что в более надежном приложении компоненты могут быть разделены, даже если они могут быть независимыми друг от друга. Редактор, конвертер, парсер и т. Д. Изображение выше - это просто простое представление о том, как происходит процедура.

Подведем итоги преобразования в четыре этапа.

Сначала мы должны создать файл Markdown, для этого мы добавляем расширение md или markdown при сохранении документа. Во время редактирования подойдет любой текстовый редактор.
Затем мы загружаем файл в какое-нибудь приложение Markdown.
Пришло время преобразовать в другой формат, в нашем случае HTML. На этом этапе необходимо приложение, посвященное Markdown.
Посмотреть результат конвертации. Если это HTML, просто откройте файл в браузере.

Некоторые моменты следует выделить

Эта процедура может отличаться в зависимости от того, где вы редактируете файл Markdown.
Когда мы говорим о простом редактировании, то есть с использованием любого универсального редактора, эти шаги более очевидны.
В случае таких издателей online, как Dillinger, StackEdit и Editor.md, этапы 2, 3 и 4 объединяются непосредственно в графическом интерфейсе этих приложений.

Использование Markdown

photo Публикация в Reddit с помощью Markdown

Ниже вы можете увидеть несколько примеров документов, которые можно создать с помощью Markdown.

Сайты

Джон Грубер и Аарон Шварц разработали Markdown, думая о Internet, поэтому создание контента для Web стало одной из самых привлекательных сторон языка.

Многие приложения, совместимые с Markdown, уже автоматически конвертируют свое содержимое в HTML.

photo Автоматическое преобразование из Markdown в HTML

Вы можете создавать полные веб-сайты, используя в качестве основы форматирование Markdown. Если это то, что вы хотите сделать, вам могут помочь такие инструменты, как Jekyll и MkDocs.

Jekyll и MkDocs - это инструменты, которые создают статические веб-сайты из документов Markdown. Знайте, что при создании веб-сайтов интересно, что вы как минимум знакомы с HTML, CSS и даже с управлением версиями файлов с помощью Git.

GitHub Pages предоставляет бесплатный хостинг для вашего статического веб-сайта.

Если вам нужно что-то более надежное, например, менеджер контента, знаменитый CMS, взгляните на Ghost.

Ghost - это бесплатная платформа с открытым исходным кодом для bloggers. Инструмент также имеет встроенный редактор Markdown.

Форматировать текст

Простота Markdown обходится без всех ярких опций редактора WYSIWYG, таких как Microsoft Word, но при этом предлагает достаточно форматирования для редактирования ваших документов.

Язык поддерживает полужирный шрифт, курсив и зачеркивание, в дополнение к, конечно, спискам, заголовкам, blockquotes и многому другому.

photo Форматирование полужирным шрифтом, курсивом и зачеркиванием в Markdown

Еще одним преимуществом форматирования документов с помощью Markdown является возможность преобразования их практически в любой другой формат текстового файла.

Ниже представлен список приложений для создания / редактирования документов Markdown:

Windows: ghostwriter или же Markdown Monster
Linux: ReText или же ghostwriter
Mac: MacDown, iA Writer или же Marked
Web: Dillinger или же StackEdit
iOS / Android: iA Writer

Примечания

Markdown - идеальный язык для заметок.

Вот список приложений, совместимых с Markdown.

: выделяется своей совместимостью с несколькими платформами. : мы вошли на территорию Apple, Bear совместим с Mac и iOS, по умолчанию не использует Markdown, но вы можете активировать его. Bear очень похож на Evernote. : это бесплатно, это просто и хранит заметки. Доступно на всех платформах. : больше ориентирован на программистов, помимо наличия открытого исходного кода.

А Evernote? OneNote? Кто-нибудь.

Что касается приложений для создания заметок, то Evernote и OneNote, без сомнения, являются самыми популярными. К сожалению, эти две программы по умолчанию не поддерживают Markdown.

В случае Evernote вы можете использовать Markdown Here или Marxico.

ПРИМЕЧАНИЕ: Markdown Here - это расширение для вашего браузера, которое позволяет вам создавать emails, используя синтаксис Markdown. Вы можете использовать это же расширение на сайте Evernote.

Книги

Что вы имеете в виду при написании книг с помощью Markdown?

Правильно, такие службы, как Leanpub, используют файлы Markdown в качестве основы, преобразование выполняется для EPUB, MOBI и PDF.

Не очень любите электронные книги?

С файлом созданной вами электронной книги вы можете загрузить его в другие службы, такие как Kindle Direct Publishing, и создавать физические копии.

Презентации slides

Да, вы правильно прочитали, вы можете создавать презентации из slides, используя Markdown.

Remark, Cleaver и Landslide - это инструменты, которые генерируют презентации slides прямо в вашем браузере, все они используют файлы md в качестве основы.

Предпочитаете использовать приложения? В macOS вы можете ссылаться на Marked или Deckset. В Windows мы можем преобразовать Markdown в slides, используя Pandoc.

Создание презентаций с использованием разметки Markdown может показаться пустой тратой времени, однако, немного попрактиковавшись, вы обнаружите, что это намного проще и быстрее, чем использование таких инструментов, как PowerPoint или Keynote.

E-mails

Большинство провайдеров e-mail предоставляют редактор WYSIWYG, интегрированный в интерфейс, но давайте посмотрим правде в глаза, многие оставляют желать лучшего, с одной стороны, много сложностей, с другой - отсутствуют параметры форматирования.

photo Интерфейс создания Gmail email

Markdown Here - решение для этих случаев. Расширение для вашего браузера, которое позволяет вам писать свой e-mails, используя форматирование Markdown.

Да, Markdown Here бесплатен, имеет открытый исходный код и мгновенно конвертирует Markdown в HTML.

Техническая документация

Markdown и техническая документация идут рука об руку. Бесчисленные компании используют файлы квугвтовзл для хранения своей документации.

GitHub перенесли свои документы на Markdown с помощью инструмента Jekyll. Кроме того, один из самых известных архивов в мире, README.md из GitHub, состоит из Markdown.

photo Документация GitHub

При создании технической документации вам могут помочь следующие инструменты:

: Создает документацию из файлов Markdown, это выбор GitHub Pages. : Просто, быстро и удобно. Основа документации - файлы .md, в конфигурации используются файлы YAML. : Генератор статических сайтов, один из лучших инструментов для создания документов. Docusaurus был разработан Facebook, поддерживает управление версиями, поиск документов и даже переводы. : Создает сайты документации на основе файлов Markdown. : По названию вы понимаете, что это как-то связано с Vue, так как VuePress - это генератор статических веб-сайтов, предназначенный для написания технической документации.

Ароматы Markdown

Представьте себе все разные диалекты, существующие в одном языке, сленг, произношения, акценты. Даже носителям языка иногда бывает сложно понять некоторые вещи.

photo Варианты синтаксиса Markdown

Что ж, как и в случае с языками, реализации Markdown в разных программах также могут отличаться, даже если разница незначительна, она все равно может вызвать путаницу.

Варианты Markdown называются Flavors, например, GitHub использует немного более надежную версию Markdown, называемую GitHub-flavored Markdown или GFM.

Некоторые приложения используют только базовый синтаксис, другие используют комбинацию базового синтаксиса и расширенного синтаксиса, и, наконец, есть приложения, которые время от времени реализуют элементы обоих.

Лучший способ понять приложение - обратиться к его документации. Вы также можете использовать старую добрую тактику проб и ошибок. См. Также наш список инструментов, в котором перечислены элементы Markdown, совместимые с каждым приложением.

В конце концов, лучший вариант - использовать программу, которая предлагает максимально возможную совместимость, например Dillinger или StackEdit.

Вывод

В этой статье вы узнали об основных аспектах Markdown, о том, что вы можете с ним делать, и о различных его реализациях.

Следующим шагом является изучение основного синтаксиса языка или, если вы уже уверены, обратитесь к разделу tools, чтобы начать использовать Markdown.

Можно, конечно, просто выложить простой, неформатированный текстовой файл. Но вам захочется сделать его удобочитаемым, чтобы ссылки были выделены, блоки кода, присутствовали таблицы и так далее…
Эта статья поможет вам в этом.

Для форматирования текста на GitHub используются достаточно простые правила. Я перечислю основные и достаточные, так как не претендую на полноту официального руководства.

Текст можно обработать в любом простом текстовом редакторе, например в Notepad++, которым пользуюсь сам. А можно и прямо на GitHub редактировать файл в он-лайн режиме.

Стилистическая разметка должна быть такой:

Разбиение на абзацы производится вставкой пустой строки между ними (нажмите "Enter" после абзаца).

Горизонтальная полоса между абзацами - тег - три или более звёздочек или дефисов

Далее - заголовки и прочее:

Если заключить адрес в угловые скобки, то он автоматически станет ссылкой

Выделение жирным шрифтом

Выделение тёмным фоном прямо в тексте

Блок текста с более тёмным фоном, четыре пробела (и более) от начала каждой строки

Блоки текста с подвеченным синтаксисом. Выделенный цветом фона блок с html-кодом. Теги выделяются цветом по правилам html

Выделенный цветом фона блок с php-кодом. Теги выделяются цветом по правилам php

Выделенный цветом фона блок с каскадными таблицами. Теги выделяются цветом по правилам css

Блок текста, выделенный тёмной полосой по левому краю (цитата)

Допустимы вложенные цитаты (цитата в цитате). Тогда цитата второго уровня выделяется двумя знаками ">>", а цитата третьего уровня вложенности - тремя.

Таблица с чередованием светлых и тёмных строк (зебра)

Нумерованный список создаётся ещё проще:

italic - наклонный шрифт. Пробел, знак препинания или подчёркивание отменяют правило маркера

Комбинируя эти маркеры вы сможете правильно разметить свой текст, сделать его более понятным.

Надеюсь, что эта статья будет вам полезна. Успехов в работе на GitHub!

UPDATE!

Вставка изображения в текст

Восклицательный знак обозначает изображение, в квадратных скобках даётся краткое описание, в обычных круглых скобках - полная ссылка на изображение.

Это мощный инструмент для копирайтеров, веб-разработчиков и контент-менеджеров. С его помощью вы сможете быстро и красиво оформлять текст. Синтаксис встроен в Ghost, Trello, Slack, Хабр и еще множество сервисов. Мы покажем несколько полезных трюков, которые сделают вас суперпользователем Markdown.

🎧 Слушайте аудио-версию этой статьи!

Что такое Markdown

Markdown - облегченный язык разметки, созданный для удобства написания и чтения текстов. Он позволяет набирать текст, не используя HTML. Сам преобразует набранное, и делает это без мусора в коде.

Вот простой пример использования Markdown:

превращается в
Экзотическая кошка - порода кошек с характерной приплюснутой мордочкой.

Попробуйте сами! Онлайн-редактор откроется в новом окне.

Почему Markdown так хорош

Вы скажете, что Markdown бесполезен - ведь можно нажимать на кнопки форматирования в редакторе и не изучать новый язык разметки.

Да, но задумайтесь: сколько времени вы тратите на нажатие этих самых кнопок? Может, секунду или даже меньше. А если вас настигло вдохновение и мысли идут потоком? Даже за секунду легко потерять нить своего повествования.

Просто попробуйте использовать Markdown, и вы удивитесь, насколько естественен его синтаксис. Этим языком пользоваться намного проще, чем чистым HTML.

Когда вы привыкнете к Markdown, вам будет очень сложно вернуться к прошлой жизни бесконечных лишних кликов.

Мы создали для вас шпаргалку, в которой описали основные функции Маркдаун.

Базовое форматирование

Заголовки

Markdown сделает всё сам и отобразит вот так:

Заголовок 2

Заголовок 3

Заголовок 4

Текст

Для форматирования текста в абзаце используются звездочки. Слово между двух звездочек выделяется курсивом, а между двух пар звездочек - жирным шрифтом. Чтобы поставить ссылку, не нужно писать теги и запоминать, что такое атрибуты. Смотрите, как просто:

курсив
жирный
жирный курсив
ссылка

Картинки

Чтобы вставить картинку, используется такой же синтаксис, как у ссылки, только со знаком восклицания:

Как и в HTML, альтернативный текст и описание при наведении - необязательные атрибуты, и вы можете обойтись без них.

Списки

+ пример списка * чтобы сделать подпункт, нажмите tab - подпункт подпункта * второй пункт

пример списка
чтобы сделать подпункт, нажмите tab
подпункт подпункта
второй пункт

Как видите, неважно, каким символом вы отмечаете пункты - можно хоть всеми по очереди. Вид подпунктов зависит только от условий в CSS.
Для нумерованного списка ничего не нужно - просто расставьте цифры, а Markdown сам добавит нужные теги.

Цитаты

Цитаты оформляются с помощью символа >.

Это цитата
Если продолжить писать дальше, это тоже будет цитата.

Надо дважды поставить "Enter".

Исходный код

Код, как в примерах выше, выделяется обратными апострофами ` - на клавиатуре они находятся на букве Ё. На макбуках эта клавиша возле левого shift или слева от буквы Z.
Три апострофа ``` выделяют блоки кода. Можно указать язык, и Markdown подсветит функции и теги.

Что ещё

~~Зачеркнутый текст~~
Чтобы Markdown не воспринимал символ, как форматирование, используйте обратный слэш \.
В предыдущем предложении используется два слэша \\ , потому что первый съедается. Но если, например, указать путь к папке Windows, один слэш отображается корректно - C:\Users\Lenovo\Documents\php.

Продвинутые техники Markdown

Освоив простое форматирование с помощью Маркдауна, вам непременно захочется узнать, как его еще можно использовать. Что ж, продолжим.

Горизонтальная черта

С помощью --- можно заменить . Не забудьте отбить энтером, иначе предыдущий текст превратится в заголовок.

Кстати, это еще один способ для выделения заголовков. С помощью === выделяются заголовки первого уровня, а с --- - второго.

Ссылки

Можно не прописывать адрес ссылки напрямую, а указать её атрибуты отдельно. Получается очень компактно. В коде это выглядит так:

Пример один, пример два.
Такие сноски можно использовать и для картинок.
Если прописать тайтл в обычной ссылке, это тоже сработает:

Наведите мышку: Яндекс
Еще можно поставить ссылку [1] на объясняющую сноску, как в книге.

Заметка в конце блока или статьи. В данном случае - в конце блока. ↩︎

Как открывать ссылки в новом окне в Маркдаун

Все ссылки в стандартном редакторе Markdown открываются в этом же окне. Только HTML-разметка позволяет изменить это. Никакие другие способы не будут работать стабильно и всегда, и в этом есть некоторое неудобство. Но имея заготовленный шаблон (смотрите ниже), вы легко справитесь с этим.

Таблицы на Markdown

Тут у Markdown перед HTML огромное преимущество. В нем делать таблицы гораздо проще:

Выглядит это так:

Заголовок таблицыДругой заголовокЯчейка 1Ячейка 2Ячейка 3Ячейка 4

Символом : можно выровнять столбцы:

В таблице работает любое форматирование:

ВлевоПо центруВправопервая ячейкатекст2~~зачеркнутая ячейка~~жирная ячейкакурсивнезачеркнутая ячейкапросто ячейка

Воспринимает ли Markdown HTML

Если вы вставите в статью обычный HTML, редактор поймет, чего вы от него хотели. Например - Курсив Курсив . Это удобно, если нужно прописать классы или атрибуты.

Горячие клавиши для MacOC

Markdown понимает сочетания горячих клавиш и сам вставляет необходимые символы. Например:

Ctrl/⌘+B - жирный текст;
Ctrl/⌘+I - Курсив;
Ctrl/⌘+K - Ссылка;
Ctrl/⌘+H и многократное нажатие для выбора нужного заголовка.

Горячие клавиши для Windows

Ctrl+B - жирный текст;
Ctrl+I - Курсив;
Ctrl+K - Ссылка;
Ctrl+H и многократное нажатие для выбора нужного заголовка.

Редакторы Markdown

Кроме использования Маркдауна в поддерживающих его синтаксис сервисах, вы можете попробовать приложения-редакторы.

Markdown для MacOS

Для Apple существует большое количество удобных программ:

Markdown для Windows

Для "микромягких" окошек программ, к сожалению, поменьше:

Что делать дальше

После пары часов использования Маркдауна ваши пальцы начнут летать над клавишами. Вы будете писать очень быстро, на ходу форматируя написанное.
Практикуйтесь, и у вас получатся превосходные статьи:

Многие программисты лихо управляются с кодом и знают мельчайшие подробности своих проектов. Но некоторым из них (в том числе и мне) недостаёт коммуникативных навыков.

Удивительное дело: программист может потратить час на подгонку внутренних и внешних отступов для одной-единственной кнопки и не найти каких-то 15 минут на файл Readme описания проекта.

Надеюсь, вы уже знаете, что такое файл readme.md и для чего он нужен.На всякий случай попробую объяснить.

Что такое Readme.md?

Посмотрите, где у нас здесь файл Readme:

Файл Readme.md находится в корневой папке репозитория и автоматически отображается в каталоге проекта на github.

Расширение .md — это сокращение от слова markdown . Это язык разметки для форматирования текста. Его используют (как и язык разметки HTML) для нормального отображения документов.

Вот как выглядит файл разметки на github (здесь использован VSCode, который одновременно показывает нам файлы разметки и в режиме предварительного просмотра):

Здесь можно найти официальный гайд Github для формата разметки на тот случай, если вам захочется основательно разобраться в языке разметки.

Зачем тратить время на Readme?

Разъяснения закончены, теперь перейдём к делу. Итак, потратив несколько часов на проект, вы выкладываете его на GitHub в надежде, что кто-нибудь (коллеги, потенциальные работодатели или бывшая) его увидит. Вы правда думаете, что они станут заглядывать в root/src/app/main.js, чтобы оценить вашу прекрасную логику? Серьёзно?

Генерирование документации для ваших компонентов

Кроме readme проекта, для понятной кодовой базы необходимо документирование компонентов, благодаря которому упрощается сопровождение кода и повторное их (компонентов) использование. Для автоматического генерирования документации к компонентам, выкладываемым на bit.dev , можно использовать такие инструменты, как Bit ( Github ).

Создание краткого описания проекта

Для проекта надо подготовить хорошее описание. При составлении описания можно придерживаться такого плана:

Некоторые нюансы

Чтобы показать код разметки, используйте значок карандаша:

1. Добавляем картинки

У вас может быть отличная фотографическая память, но интересующимся вашим проектом могут понадобиться фотографии его демо-версии.

Кроме изображений, вы можете добавить и видео-описание проекта. Вот только Github не разрешает добавлять видео в readme… Что же делать?

Читайте также: