Markdown — это упрощенный язык разметки, который можно использовать для создания форматированного текста из обычного текста с использованием определенного синтаксиса.
Он обычно используется разработчиками программного обеспечения для быстрого написания и форматирования документации по коду без использования панели инструментов форматирования.
Markdown позволяет очень быстро и легко создавать красиво отформатированную документацию для всех ваших рабочих процессов с кодом. Если вы хотите создать простой файл README, записать некоторые заметки о вашем коде или создать полное пошаговое руководство, Markdown — это то, что вам нужно!
ТАК КАК ЖЕ МНЕ ИСПОЛЬЗОВАТЬ MARKDOWN?
Хорошей новостью является то, что Markdown действительно прост в использовании, как только вы освоите синтаксис. Чтобы превратить простой текстовый файл в красиво отформатированный документ, все, что вам нужно запомнить, — это несколько специальных символов и то, что они делают с текстом.
1. ОСНОВНОЕ ФОРМАТИРОВАНИЕ ТЕКСТА
Например, одиночные звездочки \*используются для выделения текста курсивом, а двойные звездочки \*\*— жирным шрифтом:
*курсив*
**жирный**
2. ЗАГОЛОВКИ
Хэш-символы используются для создания заголовков — чем больше хэшей используется, тем ниже вы спускаетесь по иерархии заголовков. Например, один хэш #используется для первого уровня заголовка, два хэша используются для второго уровня заголовка... и так далее до 6-го уровня заголовка.
3. РАЗРЫВЫ СТРОК
Чтобы добавить в документ разрывы строк, используйте <br>.
4. ССЫЛКИ
Чтобы добавить ссылку на веб-страницу, имя ссылки заключается в квадратные скобки [ ], а URL-адрес — в круглые скобки ( )сразу за ним.
5. ИЗОБРАЖЕНИЯ
Изображения также можно вставлять аналогичным образом, но перед ними ставится восклицательный знак.
6. БЛОЧНЫЕ ЦИТАТЫ
Чтобы вставить блочную цитату, используйте >символ правой угловой скобки перед цитатой.
7. СПИСКИ
Ненумерованные списки можно создавать с помощью дефиса - :
- Пункт списка 1
- Пункт списка 2
- Пункт списка 3
8. ТАБЛИЦЫ
Вы даже можете создавать таблицы с помощью Markdown! Чтобы добавить таблицу, используйте три или более дефиса ---для создания заголовка каждого столбца и используйте вертикальную черту |для разделения каждого столбца. Вы можете выровнять текст в столбцах по левому, правому краю или по центру, добавив двоеточие :слева, справа или по обе стороны от дефиса в строке заголовка.
9. ЭКРАНИРОВАНИЕ СИМВОЛОВ
Иногда вам может понадобиться использовать один из специальных символов синтаксиса Markdown в качестве буквального символа в вашем документе вместо того, чтобы использовать его для форматирования. Для этого просто используйте обратную косую черту \перед символом.
Почему вы должны использовать Markdown?
Markdown используется везде.
Вы можете подумать, что по мере того, как форматированный текст становится все более популярным, использование Markdown перестало расти, но это не так. Популярность Markdown неуклонно росла с самого начала и, вероятно, продолжит расти. На данный момент он применяется и в Trello, и в Notion, и много где еще.
На популярных сайтах кодирования, таких как Гитхаб, Markdown является неофициальным стандартом. На данный момент он применяется и в Trello, и в Notion, и много где еще. Это также формат по умолчанию для популярных средств связи, таких как Skype, Slack. Википедия даже использует модифицированный синтаксис Markdown, известный как викитекст.
В мире кодирования, который становится все более социальным, программист, не понимающий Markdown, окажется в невыгодном положении (или, по крайней мере, на какое-то время запутается).
Так что, по крайней мере, изучите Markdown, чтобы не отставать от отрасли)
#программирование с нуля #программирование #разработчики
