Контент в Интернете должен быть представлен в формате HTML. Многие инструменты
Markdown — это простой и удобный способ написания контента для Интернета, а также идеальный способ для разработчиков создавать документацию. Он позволяет легко структурировать и форматировать документы с помощью простой текстовой разметки, которая затем преобразуется для вас в HTML — и все это в вашем любимом текстовом редакторе.
Если вы еще не используете Markdown, сейчас самое время начать. Вы можете изучить основы за считанные минуты, и при постоянном использовании синтаксис станет вашей второй натурой. В этой статье мы рекомендуем вам начать с простого и покажем, как использовать Markdown для ряда распространенных задач при создании контента.
Давайте погрузимся!
Что такое уценка?
Markdown — это облегченный язык разметки, созданный Джоном Грубером в 2004 году. Его легко писать, легко читать, и его легко преобразовать в HTML. Он был в первую очередь разработан для написания для Интернета.
Его популярность быстро возросла, и теперь он используется в контекстах, которые его создатель никогда не предполагал. Но это не идеально. У него есть ограничения, особенно потому, что он не поддерживает форматирование многих
В результате был создан ряд вариантов для решения этих проблем:
CommonMark пытается стандартизировать Markdown и сделать его менее двусмысленным, противореча при этом некоторым исходным синтаксисам.
GitHub Flavored Markdown (GFM) расширяет CommonMark и используется при создании документации на GitHub.
MultiMarkdown добавил новый синтаксис для таблиц, сносок, цитат и многого другого.
Pandoc расширяет возможности Markdown для нескольких выходных форматов (не только HTML) и поддерживает метаданные документов, сноски, таблицы, верхний и нижний индексы и многое другое.
Некоторые
Изучение уценки
Лучший способ изучить Markdown — просто начать. Выберите вариант использования и начните, будь то создание записи в блоге, работа с документацией или просто добавление базового форматирования к вашим заметкам. Подбирайте синтаксис по частям по мере необходимости.
Вы можете использовать свой любимый текстовый редактор или выбрать одно из множества приложений, предназначенных для работы с Markdown. Редакторы Markdown могут облегчить процесс обучения, поскольку они позволяют предварительно просматривать форматирование во время работы или на отдельной панели. Это означает, что вы можете сразу увидеть, используете ли вы правильный синтаксис.
Лично я использую Marked 2 для предварительного просмотра файлов Markdown на своем Mac. Это коммерческий продукт, но, конечно же, вы можете найти множество бесплатных плагинов для своего редактора. Вы также можете редактировать и просматривать файлы Markdown онлайн, используя Markdown Live Preview и StackEdit.
Чтобы получить помощь в выборе правильного редактора Markdown, обратитесь к этим сводным статьям:
Лучшие редакторы Markdown для Mac
Лучший редактор Markdown для Windows
Лучший редактор Markdown для Linux
Структурирование документов
Markdown позволяет добавлять в документ структурные элементы, такие как заголовки (h1, h2, h3и т. д.). Есть несколько способов добавить заголовки в Markdown. Мне больше всего нравится ставить перед заголовком хэши #, по одному на каждый уровень заголовка:
# Heading 1
## Heading 2
### Heading 3
etc.
And this is body text.
Хэши перемещают заголовки более низкого уровня дальше вправо, поэтому они выглядят с отступом. При желании вы можете использовать такое же количество хэшей в конце строки, чтобы закрыть заголовки:
### Heading 3 ###
Есть и второй способ, хотя я не вижу, чтобы он использовался так часто. Вы можете создать два уровня заголовков, подчеркнув заголовки H1 =символами равенства и заголовки H2 дефисами -:
Heading 1 or Title
==================
Heading 2
---------
Разделы документа можно разделить горизонтальными линиями (
) или линиями. Вы создаете их в Markdown, используя три (или более) дефиса -, звездочки, знаки *подчеркивания _или равенства. =Поместите их по отдельности на линию, с пустыми строками с обеих сторон:
Brief introduction.
===
# Chapter 1
Lots of text.
---
# Chapter 2
Some more text
---
Списки — еще один важный структурный элемент. Ненумерованные списки (
- ) создаются путем начала строки со звездочки *, символа плюса +или дефиса -, за которым следует пробел или табуляция, а затем текст:
* this
* is
* an
* unordered
* list
+ this
+ is
+ too
— and
— so
— is
— this
Выберите любой символ, который вам подходит. Вы можете переключаться между этими символами, и конечный результат будет таким же. Я предпочитаю использовать звездочки или дефисы.
Упорядоченные списки (- ) представляют собой числа, за которыми следуют точки. Номера не обязательно должны быть в порядке. Любой из них будет работать:
1. this
2. is
3. an
4. ordered
5. list
1. and
1. so
1. is
1. this
Редакторы Markdown, которые я использую, автоматически продолжают список при нажатии return.
Если вы хотите начать строку с числа и точки без начала списка, вам нужно экранировать точку обратной косой чертой \:
2020\. A year we’ll never forget.
Наконец, абзацы обычного текста разделяются одной или несколькими пустыми строками:
This will be formatted as an HTML paragraph.
And so will this.
Основное форматирование текста
Основное форматирование текста включает жирный шрифт и курсив. Подчеркивание обычно не используется в Интернете, поскольку именно так форматируются гиперссылки, поэтому оно не поддерживается Markdown. Если вы действительно хотите его использовать, просто используйте теги HTML. (Это стоит отметить в более общем плане. Если Markdown не поддерживает определенный тип
HTML-элемента , вместо этого вы можете просто использоватьHTML-разметку . Есть только одно предостережение: любой синтаксис Markdown внутриHTML-тегов не будет анализироваться.)Слова, выделенные курсивом, разделяются одной звездочкой (*) или подчеркиванием (_):
this is *italics*
and so is _this_
Слова, выделенные жирным шрифтом, разделяются двойной звездочкой (**) или подчеркиванием (__):
this is **bold**
and so is __this__
Некоторые люди предпочитают использовать либо подчеркивание, либо курсив. Например, я обычно использую звездочки для обоих **bold**и *italics*.
Другие предпочитают различать жирный шрифт и курсив, используя разные символы, например: **bold**и _italics_:
_You **can** also combine them_
Блок-котировки и блоки кодаЦитаты можно создать, начав строку с символа больше (>), точно так же, как старые почтовые клиенты цитировали предыдущие сообщения:
> This is a blockquote. Single paragraphs
> can be continued like this on a second line.
>
> Multiple paragraphs can be quoted by using a
> line with a single greater than symbol.
Мой предпочтительный способ немного проще и использует только символ «больше» в начале каждого цитируемого абзаца. Это работает независимо от того, используете ли вы редактор, который выполняет жесткую или мягкую переноску абзацев:
> You can also blockquote a paragraph
by placing a single greater than symbol at
the beginning of each paragraph.
> Nested blockquotes are also possible
> > Like this.
Блоки кода создаются путем отступа каждой строки не менее чем на четыре пробела или на одну табуляцию:
This is a normal paragraph:
This is a code block.
Но другие разновидности Markdown предпочитают использовать обратные кавычки. Например, Ulysses использует две обратные кавычки в начале строки для блока кода:
``This is a code block.
Markdown в стиле GitHub использует три обратных кавычки для начала и конца блока кода. Obsidian, Bear и некоторые другие редакторы Markdown следуют тому же соглашению:
```
This is a code block.
```
Чтобы встроить этот блок кода в блок кода, я заключил его в четыре обратных кавычки. На GitHub вы можете дополнительно включить язык, если хотите подсветку синтаксиса:
```ruby
This is Ruby code with syntax highlighting.
```
Код можно отобразить внутри абзаца, используя одиночные обратные кавычки:
This code `
` will be displayed, not interpreted. Ссылки и изображения
В ссылках и изображениях используется комбинация квадратных []и круглых скобок (). Для ссылок вы заключаете текст привязки в квадратные скобки, за которыми сразу следует
URL-адрес в круглых скобках:This is a [link to a web page] (https: //url.com).
Если хотите, вы можете добавить заголовок к ссылке. Она появится в виде всплывающей подсказки при наведении курсора на ссылку. Заключите заголовок в кавычки после URL и в круглых скобках:
This is a [link to a web page] (https: //url.com «This title will appear as a tooltip»).
Другой метод разметки ссылок известен как привязка ссылок. Они выглядят как сноски в документе Markdown, но будут преобразованы в стандартные ссылки при экспорте в HTML. Цель состоит в том, чтобы сделать документ Markdown более читабельным.
Вместо прямой ссылки на URL вы используете метку в квадратных скобках. Затем в другом месте документа (обычно внизу) вы связываете эту метку с
URL-адресом :This is a [link to a web page][mylabel].
Then at the end of the document...
[mylabel]: https://url.com «Optional title»
or
[mylabel]:
Метки не чувствительны к регистру и могут состоять из букв, цифр, пробелов и знаков препинания.
Изображения используют аналогичный синтаксис, но начинаются с восклицательного знака (!):
![Alt text] (https: //imageurl.com)
Если хотите, вы можете добавить заголовок, заключенный в кавычки внутри круглых скобок.
![Alt text] (https: //imageurl.com «This is a title»)
Вы также можете использовать справочные ссылки для изображений:
![Alt text][mylabel]
[mylabel]: https://imageurl.com «This is a title»
GitHub Flavored Markdown Extras
GitHub Flavored Markdown используется многими разработчиками и предоставляет дополнительный синтаксис, делающий его более функциональным. Вот несколько примеров.
Зачеркнутый — это дополнительная опция форматирования текста, которая достигается с помощью двойных тильд (~~):
This is how you do ~~strikethrough~~.
Списки задач можно создавать, используя — [ ]как для неотмеченных элементов, так и — [x]для отмеченных элементов:
— [ ] This item is unchecked
— [x] This item is checked
Вы можете создать таблицу, используя вертикальные черты и дефисы для рисования линий. Три или более дефиса ---создают заголовки, а вертикальные черты |создают столбцы:
| Heading 1 | Heading 2 | Heading 3 |
| --------- | --------- | --------- |
| some text | more here | and this |
| some more | this too | and this |
Это выглядит лучше, когда столбцы выровнены, но это не обязательно. В любом случае таблица будет создана корректно при экспорте в HTML:
| Heading 1 | Heading 2 | Heading 3 |
| --------- | --------- | --------- |
| some text | more here | and this |
| some more | this too | and this |
Создание такой таблицы становится довольно утомительным, особенно если вам нужно отредактировать содержимое ячеек. К счастью, есть онлайн- генераторы таблиц, которые упрощают процесс.
Заключительные слова
Уценка не для всех, но здесь есть что понравиться. Лично я ценю то, что он открыт, прост в освоении и не привязывает вас к использованию определенной программы.
Если вы дочитали до конца этой статьи, возможно, этот инструмент вам тоже подойдет. Погрузитесь и начните использовать его. Изучайте синтаксис по частям по мере необходимости, и, прежде чем вы его узнаете, он станет вашей второй натурой.
- ) представляют собой числа, за которыми следуют точки. Номера не обязательно должны быть в порядке. Любой из них будет работать:
