Важное обновление!

Код Markdown не всегда работает правильно в статьях на Medium (особенно если вы пытаетесь создать учебник по Markdown, который должен показывать как обработанный результат, так и сам код Markdown), поэтому я создал GitHub Gist. Там же можно посмотреть этот туториал, он выглядит лучше https://gist.github.com/Pajpaje/0869d669c4e9db14b528769c750f5676

Введение

Markdown — это легкий язык разметки, который позволяет писать форматированный текст с использованием простого синтаксиса.

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

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

Приложения

Уценку можно использовать для различных целей, в том числе:

1. Документация: Markdown обычно используется для создания документации, такой как файлы README, руководства пользователя и технические руководства. Он предоставляет простой способ форматирования текста и добавления изображений, ссылок и фрагментов кода. Его простой синтаксис позволяет легко писать и понимать, при этом создавая профессионально выглядящие документы.

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

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

4. Ведение блога: Markdown широко используется в сообществе блоггеров, поскольку позволяет блоггерам легко форматировать свои сообщения в блогах, добавлять изображения и создавать ссылки без использования HTML. Многие популярные платформы для ведения блогов, такие как WordPress, Medium и Ghost, поддерживают Markdown для написания сообщений в блогах.

5. Обмен мгновенными сообщениями. Некоторые платформы обмена мгновенными сообщениями, такие как Slack и Discord, поддерживают форматирование Markdown. Это позволяет пользователям форматировать свои сообщения и делать их более привлекательными и организованными.

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

7. Электронная почта. Некоторые почтовые клиенты, такие как Gmail, поддерживают Markdown для форматирования электронных писем. Это может быть полезно для создания профессионально выглядящих электронных писем, особенно для деловой переписки.

Основной синтаксис

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

Заголовки

Чтобы создать заголовок, используйте один или несколько символов `#` перед текстом. Количество символов `#` указывает на уровень заголовка, от уровня 1 до уровня 6.

Например:

# Заголовок 1

## Заголовок 2

### Заголовок 3

Перерывы

Набрав — — — , вы можете вставить разрывы (сплошные горизонтальные линии). В большинстве случаев вам также потребуется пустая строка до и после.

Это отобразит разрыв страницы ниже этой строки:

— — —

Стили текста

Чтобы выделить текст курсивом, окружите его символами `_` или `*`.

Чтобы сделать текст полужирным, окружите его символами `**`.

Чтобы сделать текст как курсивом, так и полужирным, окружите его символами `***`.

Чтобы сделать зачеркивание, используйте символы `~~`.

Чтобы использовать моноширинный шрифт, заключите текст в одинарную кавычку. (`) Используйте его для пути к файлу и имен файлов, а также для текста, который пользователи вводят, или текста сообщения, который видят пользователи.

Примеры:

Это _italic_ текст. Это также *курсив* текст.

Это **жирный** текст.

Это ***полужирный курсив***.

Это ~~зачеркнуто~~.

Это `моноширинный` текст.

Списки

Чтобы создать маркированный список, начинайте каждую строку с символа `*` или `-`.

Например:

* Яблоки

* Апельсины

* Бананы

Чтобы создать нумерованный список, начинайте каждую строку с числа, за которым следует символ `.`.

Например:

1. Яблоки

2. Апельсины

3. Бананы

Ссылки

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

https://www.google.com

Вы также можете использовать следующий синтаксис для установки отображаемого текста:

[Текст ссылки](URL-адрес ссылки)

Например:

[Google](https://www.google.com)

Изображения

Чтобы добавить изображение, используйте следующий синтаксис:

![Альтернативный текст](URL-адрес изображения)

Например:

![Милый кот](https://i.imgur.com/abc123.jpg)

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

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

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

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

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

![Милый кот](https://i.imgur.com/abc123.jpg «Название изображения»)

Код

Чтобы добавить встроенный код, окружите его обратными кавычками (`).

Например:

Используйте `git status`, чтобы проверить состояние вашего репозитория Git.

Расширенный синтаксис

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

Таблицы

Чтобы создать таблицу, используйте символы `|` для разделения столбцов и символы `-` для создания строки заголовка.

Например:

| Колонка 1 | Колонка 2 | Колонка 3 |

| — — — — | — — — — | — — — — |

| Строка 1, столбец 1 | Строка 1, столбец 2 | Строка 1, столбец 3 |

| Строка 2, столбец 1 | Строка 2, столбец 2 | Строка 2, столбец 3 |

Блокировать цитаты

Чтобы создать блочную цитату, начните строку с символа `›`.

Например:

› Быть или не быть, вот в чем вопрос.

Блоки кода

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

Вы также можете окружить код символами ``` (они должны быть на отдельных строках). Вы можете включить язык после первых обратных кавычек, если поддерживается подсветка синтаксиса.

Например:

```Питон

определение hello_world():

print("Привет, мир!")

```

Инструменты

Существует множество инструментов для работы с Markdown. Вот несколько популярных:

Редакторы уценки

Онлайн-редакторы

Инструменты преобразования

Заключение

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

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

Приятного письма!

Ссылки

- [Руководство по уценке] (https://www.markdownguide.org/)

- [GitHub Flavored Markdown] (https://github.github.com/gfm/)