Skip to content

Latest commit

 

History

History
227 lines (172 loc) · 7.81 KB

README.md

File metadata and controls

227 lines (172 loc) · 7.81 KB
Raw

Руководство по языку разметки Markdown

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

Чтобы выделить текст курсивом необходимо обрамить его звездочками * или знаком нижнего подчеркивания _. Например:

*вот так* или _вот так_

вот так или вот так

Чтобы выделить текст полужирным необходимо обрамить его двойными звездочками ** или двойным знаком нижнего подчеркивания __. Например:

**вот так** или __вот так__

вот так или вот так

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

_текст может быть выделен курсивом и при этом быть **полужирным**_

текст может быть выделен курсивом и при этом быть полужирным

Для комбинации полужирного и курсива можно сочетать символы в различном порядке:

__*вот так*__ или _**вот так**_

вот так или вот так

Для зачёркивания текста используется выделение символами тильда (~~):

~~зачёркнутый текст~~

зачёркнутый текст

Списки

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

Чтобы добавить ненумерованные списки необходимо пункты выделить звездочками *, или знаками +/-. Например, вот так:

* element 1
* element 2
* element 3

- element 1
- element 2
- element 3

+ element 1
+ element 2
+ element 3
  • element 1
  • element 2
  • element 3
  • element 1
  • element 2
  • element 3
  • element 1
  • element 2
  • element 3

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

Чтобы добавить нумерованные списки необходимо пункты просто пронумеровать. Например, вот так:

  1. element 1
  2. element 2
  3. element 3

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

Вложенные списки оформляются отступами.

1. element 1
    1. element 1.1
    2. element 1.2
2. element 2
  1. element 1
    1. element 1.1
    2. element 1.2
  2. element 2
1. element 1
    * element 1.1
    * element 1.2
2. element 2
  1. element 1
    • element 1.1
    • element 1.2
  2. element 2
* element 1
    * element 1.1
    * element 1.2
* element 2
  • element 1
    • element 1.1
    • element 1.2
  • element 2

Заголовки

Для оформления заголовков используются символы решетки #.

# Header 1
## Header 2
### Header 3
#### Header 4
##### Header 5

Header 1

Header 2

Header 3

Header 4

Header 5

Также для первых двух уровней можно использовать подчёркивание с помощью символов === и ---.

Header 1
===
Header 2
---

Header 1

Header 2

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

Выделение блоков текста чертой сверху или снизу выполняется с помощью дефисов --- или символов нижнего подчёркивания ___.

---
Блок, отделённый чертой сверху
или
___
Блок, отделённый чертой сверху

Блок, отделённый чертой сверху

или

Блок, отделённый чертой сверху

Блок, отделённый чертой снизу
___

Блок, отделённый чертой снизу

Работа с изображениями

Чтобы вставить изображение в текст достаточно написать следующее (в квадратных скобках указывается наименовение изображения, в круглых — сслыка на него):

![git logo](https://git-scm.com/images/[email protected])

git logo

Чтобы вставить локальный файл указывается имя файла:

![Java type cast](type_cast.png)

Java type cast

Ссылки

Ссылка в тексте оформляется так же, как изображение, только без восклицательного знака. Например, так:

Актуальная версия книги Pro Git на [английском](https://git-scm.com/book/en/v2) и [русском](https://git-scm.com/book/ru).

Актуальная версия книги Pro Git на английском и русском.

Работа с таблицами

Нативный стандарт Markdown не поддерживает работу с таблицами. Но в его варианте на GitHub GFM (GitHub Flavored Markdown) можно использовать вертикальную черту | и дефис -. Например, так:

| Заголовок 1 | Заголовок 2 |
| ----------- | ----------- |
| Ячейка 1-1  | Ячейка 2-1  |
| Ячейка 1-2  | Ячейка 2-2  |
Заголовок 1 Заголовок 2
Ячейка 1-1 Ячейка 2-1
Ячейка 1-2 Ячейка 2-2

Для выравнивания текста внутри ячейки используются двоеточия:

| Выравнивание влево | Выравнивание по центру | Выравнивание вправо |
| :----------------- | :--------------------: | ------------------: |
| Ячейка 1-1         | Ячейка 2-1             | Ячейка 3-1          |
| Ячейка 1-2         | Ячейка 2-2             | Ячейка 3-2          |
Выравнивание влево Выравнивание по центру Выравнивание вправо
Ячейка 1-1 Ячейка 2-1 Ячейка 3-1
Ячейка 1-2 Ячейка 2-2 Ячейка 3-2

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

Заголовок 1 | Заголовок 2
----------- | -----------
Ячейка 1-1  | Ячейка 2-1
Ячейка 1-2  | Ячейка 2-2
Заголовок 1 Заголовок 2
Ячейка 1-1 Ячейка 2-1
Ячейка 1-2 Ячейка 2-2

Цитаты

Цитаты оформляются угловой скобкой вправо, как в e-mail:

> _"I’m very happy with git. It works remarkably well for the kernel and is still meeting all my expectations." — Linus Torvalds_

"I’m very happy with git. It works remarkably well for the kernel and is still meeting all my expectations." — Linus Torvalds

> Также можно использовать
>> вложенное цитирование

Также можно использовать

вложенное цитирование