Шпаргалка по Markdown

Agenda не является редактором markdown, но всё же распознаёт часть синтаксиса markdown для применения стилей. Ниже перечислены доступные сокращения markdown.

Стили параграфов

Следующие стили меняют внешний вид всего абзаца целиком.

Заголовок

Поставьте в начале строки от 1 до 6 знаков решётки, а за ними пробел. Уровень заголовка определяется количеством решёток. Например, ### Пример даёт заголовок третьего уровня.

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

Начните строку с буллета, дефиса, звёздочки или знака плюс, чтобы получить пункт маркированного списка. Например, • Пример пункта 1 - Пример пункта 2 * Пример пункта 3 + Пример пункта 4 даёт пункт списка с тире или буллетом.

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

Начните строку с числа, за которым следуют точка и пробел, чтобы получить пункт нумерованного списка. Например, \1. Пример пункта 1 даёт пункт нумерованного списка.

Чтобы начать нумерованный список не с 1, а с другого числа, просто укажите это число Например, \3. Пример пункта 3 даёт пункт нумерованного списка, начинающийся с 3.

Контрольный список

Начните строку с дефиса, за которым следуют открывающая и закрывающая квадратные скобки. Если между скобками вставить «x», получится отмеченный пункт. Например, - [ ] Пример даёт пункт контрольного списка.

- [x] Пример даёт отмеченный пункт.

Дефис необязателен, поэтому создать флажок можно и просто двумя квадратными скобками.

Преформатированный

Для содержимого, которое лучше смотрится моноширинным шрифтом, например программного кода, можно применить преформатированный стиль. Этот стиль включается, если начать строку с трёх обратных апострофов. Например, ```sample даёт sample

Код

Agenda поддерживает подсветку синтаксиса программного кода. Добавив после трёх обратных апострофов название языка, вы укажете, на каком языке написан фрагмент кода. Например, ```swift int i = 0; даёт int i = 0 с подсветкой по правилам языка Swift

Полный список всех поддерживаемых обозначений языков ведёт проект highlight.js: https://github.com/highlightjs/highlight.js/blob/main/SUPPORTED_LANGUAGES.md.

Блок цитаты

Поставьте в начале строки один или несколько символов >, а за ними пробел. Количество символов > определяет уровень цитирования, обозначенный вертикальными линиями перед текстом. Например, > Пример даёт

Пример

Стили внутри текста

Эти стили применяются внутри абзацев и меняют внешний вид текста.

Курсив

Обрамление символами подчёркивания или звёздочками даёт курсивное начертание. Например, _пример_ или *пример* даёт пример

Жирный

Обрамление двойными символами подчёркивания или двойными звёздочками даёт жирное начертание. Например, __пример__ или **пример** даёт пример

Зачёркнутый

Обрамление двойными тильдами даёт зачёркнутое начертание. Например, ~~пример~~ даёт ~~пример~~

Фиксированная ширина (моноширинный)

Для некоторого содержимого, например исходного кода программ, предпочтителен текст фиксированной ширины. Для блоков текста лучше всего использовать стиль параграфа Преформатированный. Для текста внутри строки можно обрамить его обратными апострофами. Например, `пример` даёт пример

Подсветка

Обрамление двойными знаками равенства или двоеточиями даёт подсветку. Например, ==пример== или ::пример:: подсвечивает слово «пример»

Вставка

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

Теги могут также содержать параметр в круглых скобках. Например, #due(12/12/2018). Чтобы узнать больше о том, как в полной мере использовать параметры в тегах, смотрите главу Теги, люди, текстовые действия и ссылки.

Теги людей

Agenda распознаёт второй тип тегов, зарезервированный для отдельных людей. Вы можете ввести имя или инициалы, чтобы сослаться на друга или коллегу. Просто поставьте перед текстом символ @. Например, Введите @Tom, чтобы создать тег человека по имени «Tom».

Ввод символа @ вызывает всплывающее окно автодополнения, помогающее найти нужного человека.

Эмодзи

Чтобы ввести эмодзи, просто наберите : (двоеточие), затем краткое обозначение эмодзи и снова закрывающее :. Например, Наберите :+1:, чтобы вставить эмодзи 👍.

Ввод символа : вызывает всплывающее окно автодополнения, помогающее найти нужное эмодзи.

Горизонтальное правило

Если вам нравится визуально разделять части заметок горизонтальным правилом (горизонтальной линией), наберите подряд три дефиса, а затем пробел: Например, Введите ---, чтобы создать горизонтальное правило.

Совет: если вы импортируете файл markdown, его можно разбить на отдельные заметки в Agenda с помощью тех же трёх дефисов подряд: Например, Первая заметка --- Вторая заметка

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

Таблицы

Agenda позволяет вставлять в заметки таблицы, которые можно быстро создать, набрав в начале строки три или более символов вертикальной черты (|) подряд: Например, Введите |||, чтобы вставить таблицу.

Ссылки

Ссылки распознаются в тексте автоматически, но их можно добавить и с помощью синтаксиса markdown. Заключите отображаемый текст в квадратные скобки, а за ними в круглых скобках укажите URL ссылки. Например, Введите [Agenda](agenda.com), чтобы создать ссылку на agenda.com, привязанную к тексту «Agenda».

Текстовые действия

Хотя это и не относится строго к классическому синтаксису markdown, Agenda позволяет запускать определённые действия, если сначала набрать символ обратной косой черты , а за ним действие.

Например, \remind вставит в вашу заметку напоминание. В составе действия можно указать необязательные параметры: скажем, \remind(today at noon) назначит напоминание на сегодня в полдень. Другие распространённые действия — \now, \date и \time, вставляющие текущие дату и время.

Полный обзор всех действий смотрите в главе Шпаргалка по текстовым действиям.

Действия можно также использовать как заполнители в шаблонах, см. главу Создание и использование шаблонов.

Как отключить разбор markdown

Хотя сокращения markdown бывают чрезвычайно удобными и быстрыми, порой что-то не нужно распознавать как markdown. Приведённые выше последовательности markdown можно экранировать, набрав сначала символ обратной косой черты \, а затем то, что вы обычно набираете. После нажатия пробела обратная косая черта должна автоматически исчезнуть, а текст останется таким, каким вы его набрали. Например, ввод \1. Что-нибудь не приведёт к созданию нумерованного списка, а даст текст 1. Что-нибудь.

Учтите, что markdown никогда не разбирается внутри текста со стилем параграфа Преформатированный и стилем внутри текста Фиксированная ширина.