Markdown для начинающих — Создайте лучшее Readme


Что такое Markdown?

Markdown — один из самых популярных языков разметки. Разработанный Джоном Грубером в 2004 году, он представляет собой простой и легкий способ добавления форматирования (и изящества) в обычные текстовые документы. По словам Грубера:

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

В то время как многие из нас привыкли к текстовым редакторам типа Microsoft Word, где изменения видны сразу, Markdown использует уникальный синтаксис обычного текста для изменения его вида. В этом руководстве мы рассмотрим часто используемый синтаксис Markdown, чтобы вы могли создать лучший GitHub README!

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


Заголовки

Имеется 6 заголовков, от H1 до H6.

Ниже приведен синтаксис Markdown:

# Heading 1
## Heading 2
### Heading 3
#### Heading 4
##### Heading 5
###### Heading 6
Войти в полноэкранный режим Выйти из полноэкранного режима

Заголовок 1

Заголовок 2

Заголовок 3

Заголовок 4

Заголовок 5
Заголовок 6

Добавление подчеркивания в текст

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

**bold**
_italic_
<u>underlined</u>
~~strike through~~
Вход в полноэкранный режим Выход из полноэкранного режима

БОНУС: Подстрочные и надстрочные знаки

Иногда мы можем захотеть использовать надстрочные знаки для таких вещей, как химические обозначения H20 или экспоненты x2. С Markdown это просто:

H<sub>2</sub>0
x<sup>2</sup>
Войти в полноэкранный режим Выйти из полноэкранного режима

Для суперскриптов вы окружаете элемент, который хотите сделать субскриптом, тегом ‘sub’. Для субскриптов вы окружаете элемент тегом ‘sup’.


Выделение синтаксиса и блоков кода

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

В этом предложении слово hello будет выделено.

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

const makeAVariable = 'Hello'

// This will show different colors 
console.log(makeAVariable)
Войти в полноэкранный режим Выход из полноэкранного режима

Кавычки

Чтобы показать цитату, используйте символ «больше чем». Кавычки очень полезны, когда вы ссылаетесь на чью-то работу. Важно отдать должное, когда это необходимо.

«Обязательно сохраняйте свой код!» — Меган


Списки

Чтобы создать упорядоченный список, начните с 1 и считайте вверх.

  1. Пункт первый
  2. Пункт второй
  3. Пункт третий

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

  1. Пункт первый
    1. Подпункт один
    2. Подпункт два
  2. Пункт второй
    • Подпункт три
  3. Пункт третий

Неупорядоченные списки создаются с помощью знака минус перед каждым элементом. См. ниже:

Список покупок:

  • хлопья
  • яйца
  • сыр

Изображения и Emojis

Чтобы добавить изображение, используйте восклицательный знак, затем квадратные скобки, содержащие текст alt, а затем html-ссылку в круглых скобках, как показано ниже: ![alt text](url).

Вы также можете использовать эмодзи в Markdown. Полный список распознаваемых эмодзи находится здесь.

😍👍🐰


Ссылки

Чтобы создать ссылку, просто поместите текст ссылки в квадратные скобки, а затем круглые скобки, заключающие URL, на который вы хотите указать. Синтаксис выглядит следующим образом: [](url).

Посмотрите несколько замечательных ссылок ниже!
Мой GitHub
Мой LinkedIn


Это было краткое руководство по созданию более красивых файлов README с помощью Markdown. Покажите мне свой новый README в комментариях ниже!

Оцените статью
devanswers.ru
Добавить комментарий