Руководство по оформлению Markdown файлов

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

Заголовки

# # # # # # # # # # # З # # # # а З # # # г а З # # о г а З # л о г а З о л о г а З в о л о г а о в о л о г к о в о л о к о в о л п к о в о е в к о в р т т к о в о р ч к о р е е п г о т т я ш о г ь в т е о е ё о с у г р г т р у о т о о о р о г в о у г у о н в р о р я н о о у я в у в р н р н о я о я в в н н я я

Пример:

Заголовок первого уровня

Заголовок второго уровня

Заголовок третьего уровня

Заголовок четвёртого уровня

Заголовок пятого уровня
Заголовок шестого уровня

Параграфы и переносы строк

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

Пример:

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

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

Выделение текста

* _ ~ к к * _ ~ у у ж ж * _ з р р и и ж ж а с с р р и и ч и и н н р р е в в ы ы н н р * _ й й ы ы к * _ й й н * _ у к к т у у ы р р й с с ~ и и ~ в в * _ * _ * _

Пример:

курсив
курсив

жирный
жирный

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

зачеркнутый

Списки

Нумерованный список

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

Пример:

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

Маркированный список

- - - П П П у у у н н н к к к т т т п в т е т р р о е в р т ы о и й й й

Пример:

  • Пункт первый
  • Пункт второй
  • Пункт третий

Вложенные списки

Также можно делать вложенные списки, добавляя 4 пробела перед пунктом:

1 2 . . П П у - - у н н к П П к т о о т д д п п п в е у у т р н н о в к к р ы т т о й й п в е т р о в р ы о й й

Пример:

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

Ссылки

[ Т е к с т с с ы л к и ] ( h t t p s : / / w w w . e x a m p l e . c o m )

Пример:

Текст ссылки

Изображения

! [ Т е к с т о п и с а н и я ] ( h t t p s : / / w w w . e x a m p l e . c o m / i m a g e . j p g )

Пример:

Текст описания

Блоки кода

Строка кода

` с т р о к а к о д а `

Пример:

строка кода

Блок кода

Удалите символы \

\ Б \ ` л ` ` о ` ` к ` к о д а

Пример:

Б л о к к о д а

Подсветка кода

Для блоков кода можно указывать язык программирования.

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

Удалите символы \

\ p \ ` r ` ` i ` ` n ` p t y ( t " h П o р n и в е т , м и р ! " )

Пример:

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

Цитаты

> П е В р т Т в о р ы р е й о т й и у й р у о р у в о р е в о н е в ь н е ь н ц ь и ц т и ц и т и р и т о р и в о р а в о н а в и н а я и н я и я

Пример:

Первый уровень цитирования

Второй уровень цитирования

Третий уровень цитирования

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

Пример:

Таблицы

З Я Я а ч ч г е е о й й л к к о а а в о 1 3 к 1 З Я Я а ч ч г е е о й й л к к о а а в о 2 4 к 2

Пример:

Заголовок 1 Заголовок 2
Ячейка 1 Ячейка 2
Ячейка 3 Ячейка 4

Таблица как HTML

< t / a t b a l < < < b e t / t / t / l > r t r t r t e > r > r > r > < < > < < > < < > t t t t t t h h d d d d > > > > > > З З Я Я Я Я а а ч ч ч ч г г е е е е о о й й й й л л к к к к о о а а а а в в о о 1 2 1 2 к к . . . . 1 1 2 2 1 2 < < < < < < / / / / / / t t t t t t d d d d h h > > > > > >

Пример:

Чек-листы

- - - [ [ [ x ] ] ] З З З а а а д д д а а а ч ч ч а а а 1 2 3

Пример:

  • Задача 1
  • Задача 2
  • Задача 3

Внутренние ссылки

[ # К П # а е к р < о е a й й - т i т и d о = к " к t о З i н а t т г l е о e н л 1 т о " в > к З у а г 1 о ] л ( о # в t о i к t l 1 e < 1 / ) a >

Пример:

Перейти к Заголовку 1

Заголовок 1

Какой-то контент

Ссылка на заголовок на английском

[ # S S # o o m m S e e o m c t e o i n t T t l i e e t n l t 1 e ] ( 1 # s o m e - t i t l e - 1 )

Пример:

Some title 1

Some Title 1

Some content

Автоматические ссылки

< < h a t d t d p r : e / s / s e @ x e a x m a p m l p e l . e c . o c m o / m > >

Пример

http://example.com/

address@example.com

HTML

Markdown поддерживает использование прямого HTML внутри документа, так что вы можете использовать любые HTML-теги для более сложного оформления:

< k b d > C T R L < / k b d > < k b d > P < / k b d >

Пример:

CTRL + P

HTML-коды

Например, вы можете использовать HTML-код &macr; для добавления черты над буквой:

A & m a c r ;

Пример:

A¯

Комментарии

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

[ / / ] : # ( Э т о к о м м е н т а р и й , о н н е б у д е т о т о б р а ж а т ь с я )

Пример:

Эмодзи (Github)

Вы можете использовать эмодзи в своих Markdown-файлах. Существует множество эмодзи, которые вы можете использовать, вот некоторые из них:

: : : s l b m a l i u u l g s e h h : i : n g :

Пример:

:smile: :laughing: :blush: