Документация по статьям руководства
- Перейти к
- Выноски
- Снимки экрана
В этом документе объясняется синтаксис Markdown, применяемый в Asana.
Это заголовок 2-го уровня (мы не используем в статьях заголовки 1-го уровня)
Язык разметки текстов Markdown — штука довольно причудливаяпричудливая, но чтобы всё было в лучшем виде, мы создали несколько специальных коротких кодов. Для вставки подсказок используется компонент ТерминТерминОпределение
. При этом нужно проконтролировать, чтобы термин и его определение присутствовали в файле __glossary.md
. Допускаются даже слова во множественном числе и глаголы в неинфинитивной форме! Используйте терминытермины с осторожностью. Если необходимо применить глагол в другой форме или слово с другим окончанием, следует использовать дополнительный параметр text
: ТерминТерминОпределение
.
Это заголовок 3-го уровня
Можно создать ссылку на другую страницу, но если она находится на нашем сайте, это следует делать без использования домена (https://asana.com). Это нужно, чтобы избежать перенаправления в другое место, когда мы работаем с промежуточными серверами! Видели курсив? Слова можно выделять жирным шрифтом, курсивом или и тем и другим одновременно, применяя символы подчёркивания и звёздочки. Если хочется проявить фантазию, воспользуйтесь символом обратной кавычки, который находится на клавише со знаком тильда (волнистая линия ~
). С помощью этого символа текст кода или сочетания клавиш можно набрать моноширинным шрифтом.
Если у вас длинный код или просто нужно перенести его новую строку, используйте три символа тильда перед кодом и после него.
А это заголовок 4-го уровня
- взгляните на
- список с числами
- а вот маркированный
- список
- Можно даже создавать вложенные списки
- В том числе и маркированные!
-
Фактические числа не имеют значения. Это просто числа
-
Упорядоченный подсписок
-
С элементами одного уровня
-
О! Я использовал тот же номер!
-
И ещё один элемент.
В элементах списка можно делать абзацные отступы, если добавить отступ на один или несколько пробелов и поставить перед ними дополнительный разрыв строки.
Заголовки уровня 5...
И 6-го уровня почти никогда не используются.
- В неупорядоченном списке могут использоваться звёздочки
- Или знаки минус
- Или знаки плюс
- На странице все они выглядят одинаково.
Выноски и блоки цитирования
Блок цитирования выглядит вот так. Все блоки цитирования оформляются в виде советов Asana. Обратите внимание, что часть «Совет Asana» добавляется автоматически. Чтобы начать блок цитирования, необходимо набрать один символ «больше»: знак
>
и обычный синтаксис Markdown здесь тоже работают!
Но, возможно, вам понадобится специальная выноска:
(Неприятные) обстоятельства, которые часто «ломают» страницу:
- Вы пропустили одну из строк с тремя дефисами, обозначающих начало и конец YAML
- Вы забыли проконтролировать, чтобы использовались
"двойные кавычки"
и чтобы они были вокруг всех значений в YAML. Или же двойные кавычки превратились в неправильные“изогнутые кавычки”
в результате переноса из документа MS Word. - Значения отступа в списках неодинаковы. Количество пробелов имеет значение
- Произошло какое-то нарушение при копировании и вставке: просмотрите все внесённые изменения и сравните их с аналогичными страницами, как будто вы решаете задачку «Найдите десять отличий».
Изображение и классы
В начале изображения ставится символ !
, а далее идёт то же, что и у любой другой ссылки. Не забывайте про замещающий текст в квадратных скобках и никогда не оставляйте пробелы между квадратными и круглыми скобками.

Если добавить компонент {.screenshot}
, то при наведении курсора на изображение на экране будет появляться увеличительная лупа. В качестве замещающего текста вводится описание снимка экрана.
{.screenshot}

Если снимок экрана нужно сопроводить списком или подписью, придётся применить некоторый HTML-код:
<div class="screenshot-container" markdown="1">
{.screenshot}
#### Это необязательный заголовок списка
1. **Ух ты!** Это упорядоченный список
1. Но он _мог_ бы быть маркированным
1. Или даже абзацем [со ссылками](#top)!
</div>

Это необязательный заголовок списка
- Ух ты! Это упорядоченный список
- Но он мог бы быть маркированным
- Или даже абзацем со ссылками!
Ниже приводится пример обычного маркированного списка.

Это необязательный заголовок списка
- Заголовок. Это неупорядоченный список
- Его ещё называют маркированным
- Чего только не бывает!
Поменяйте параметр screenshot
на phone
в классе контейнера, чтобы он работал и на мобильных устройствах:
В разделе «Настройки» можно:
- Обратиться в службу поддержки
- Оценить приложение
- Выйти из учётной записи
В случае обычных мобильных изображений нужен только класс {.phone}
.
Whoa, it's a horizontal rule! All you need to do is type in ***
or - - -
on it's own line
Это | таблица |
---|---|
ячейка A | ячейка B |
ячейка C | ячейка D |
Кроме того, здесь может быть много текста, | а также элементов, выделенных жирным шрифтом, и ссылок |