Skip to content

Latest commit

 

History

History
121 lines (74 loc) · 7.21 KB

Markdown instruction.md

File metadata and controls

121 lines (74 loc) · 7.21 KB

Инструкция для работы с Markdown

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

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

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

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

Списки

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

  • Элемент 1
  • Элемент 2
  • Элемент 3
  • Элемент 4

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

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

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

Чтобы вставить изображения в текст, достаточно написать следующее: Пиала В квадратных скобках пишется текст, который покажется, если изображение по каким-то причинам не загрузится.

Ссылки

Все ссылки должны быть безопасными (с протоколом https вместо http), если целевой объект поддерживает такой протокол (большинство целевых объектов поддерживают).

Для создания внешней ссылки необходимо выделить текст квадратными скобками и добавить ссылку в круглых скобках.

Инструкция для Markdown

Ссылка на файл служит для перехода от одной статьи к другой в наборе документации:

  • В путях к файлам используются прямые (/), а не обратные косые черты.

  • Для статьи, в которую добавляется ссылка на другую статью в том же каталоге:

    link text

  • Для статьи, в которую добавляется ссылка на статью в родительском каталоге текущего каталога:

    link text

  • Для статьи, в которую добавляется ссылка на статью в подкаталоге текущего каталога:

    link text

  • Для статьи, в которую добавляется ссылка на статью в подкаталоге родительского каталога текущего каталога:

    link text

  • Некоторые статьи состоят из .yml файлов и .md , где .yml файл содержит метаданные, а .md содержит содержимое. В этом случае укажите ссылку на .yml файл :

    link text (неlink text)

Ссылка для закладок

  • Чтобы добавить ссылку закладки на заголовок в текущем файле, используйте символ решетки, за которым следует текст заголовка в НИЖНЕМ регистре. Удалите знаки препинания из заголовка и замените пробелы дефисами.

    Например: Работа с ссылками

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

    Например: Managed Disks

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

  1. Использование вертикальных линий и строк является самым простым способом создания таблиц в Markdown. Чтобы создать стандартную таблицу с заголовком, вставьте пунктирную линию после первой строки.

    Например:

    Столбец 1 Столбец 2 Столбец 3
    Строка 1.1 Строка 1.2 Строка 1.3
    Строка 2.1 Строка 2.2 Строка 2.3
    Строка 3.1 Строка 3.2 Строка 3.3

    Название столбцов отделяется -----

  2. Можно выровнять столбцы с помощью двоеточий: Например:

    Столбец 1 Столбец 2 Столбец 3
    Выравнивание слева Выравнивание по середине Выравнивание справа
    Строка 2.1 Строка 2.2 Выравнивание справа
    Выравнивание слева Выравнивание по середине Выравнивание справа

Цитаты

Блоки цитирования создаются с помощью символа ">".

Это блок цитирования. Обычно он отображается с отступом и имеет другой цвет фона.

Заключение

Markdown позволяет составлять подробные и удобные инструкции. Дополнительно можно выделять разделы с помощью блоков "Примечание", "Совет", "Важно!", "Предупреждение", "Внимание!"

Например:

Note

Information the user should notice even if skimming.

Tip

Optional information to help a user be more successful.

Important

Essential information required for user success.

Caution

Negative potential consequences of an action.

Warning

Dangerous certain consequences of an action.