Пишите на Markdown

Markdown хорошо подходит для исследовательских заметок, отчётов и ранних черновиков. Oleafly даёт ему отдельную панель форматирования и сборочный путь Pandoc, а исходные файлы можно использовать и вне приложения.

Создайте отчёт

1. Выберите Новый проект → Использовать шаблон → Пустой документ Markdown.
2. Назовите проект Полевые заметки и откройте main.md.
3. Вставьте этот пример, затем выберите Скомпилировать заново или нажмите ⌘Enter / Ctrl+Enter.
4. Если Oleafly предложит настроить нужный движок, завершите настройку и скомпилируйте ещё раз.

main.md

---
title: "Field notes"
author: "Alex Chen"
date: ""
---

# Question

Does the revised procedure reduce measurement time?

## Method

1. Prepare the sample.
2. Repeat the measurement three times.
3. Record the elapsed time.

## Observations

| Run | Time (s) | Note |
| --- | --- | --- |
| 1 | 12 | First pass |
| 2 | 10 | Repeated pass |

The **mean time** will be compared with the baseline.

В PDF должны быть название, заголовки, нумерованный список и таблица. Метаданные между первой парой строк --- задают название документа и автора.

Редактирование исходника и визуальное редактирование

У переключателя в начале панели инструментов три режима. Код редактирует Markdown напрямую. Визуально даёт форматированное редактирование заголовков, абзацев, списков, ссылок, изображений и таблиц. Оба показывает исходник и форматированный текст вместе. Откройте его меню, чтобы выбрать Друг под другом или Разделить. Новые проекты открываются в режиме «Код», и каждый проект запоминает режим, в котором вы его оставили.

Подчёркивание, выделение цветом, верхний и нижний индексы — это инструменты форматирования Pandoc в режиме «Код». Их кнопки скрыты в режиме «Визуально». Используйте «Код» для работы с метаданными, синтаксисом цитирования и другими конструкциями исходника.

Скачать исходник примера

Каждый инструмент панели инструментов

Выделяйте текст перед щелчком по инструменту форматирования. В режиме «Код» большинство инструментов обёртывает выделение или вставляет заполнитель. Откройте Другие параметры форматирования (…), чтобы добраться до элементов, не поместившихся в панель.

Код / Визуально

Переключайтесь между режимами Код, Визуально и Оба. В любом режиме документ остаётся исходником Markdown.

Отменить

Отменяет последнее изменение. ⌘Z / Ctrl+Z.

Повторить

Возвращает отменённое изменение. ⌘Shift+Z / Ctrl+Shift+Z.

Заголовок → Название

Выберите Название в меню заголовков, чтобы вставить # Title. Замените текст заголовка на собственный.

Заголовок → Раздел

Выберите Раздел в меню заголовков, чтобы вставить ## Section. Замените текст заголовка на собственный.

Заголовок → Подраздел

Выберите Подраздел в меню заголовков, чтобы вставить ### Subsection. Замените текст заголовка на собственный.

Заголовок → Подподраздел

Выберите Подподраздел в меню заголовков, чтобы вставить #### Subsubsection. Замените текст заголовка на собственный.

Заголовок → Мелкий заголовок

Выберите Мелкий заголовок в меню заголовков, чтобы вставить ##### Minor heading. Замените текст заголовка на собственный.

Заголовок → Заголовок абзаца

Выберите Заголовок абзаца в меню заголовков, чтобы вставить ###### Paragraph heading. Замените текст заголовка на собственный.

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

Начинает неупорядоченный список. - Item.

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

Начинает последовательность. 1. Item.

Список задач

В режиме «Код» добавьте задачу и замените [ ] на [x], когда она выполнена. - [ ] Task.

Цитата блоком

Помещает цитату на отдельной строке. > quoted text.

Полужирный

Выделяет выделенный текст. **text**; ⌘B / Ctrl+B.

Курсив

Выделяет термин курсивом. *text*; ⌘I / Ctrl+I.

Зачёркнутый

Помечает текст как устаревший. ~~text~~.

Код в строке

Форматирует имя файла, команду или идентификатор. Текст в обратных кавычках.

Подчёркнутый

Выделите фразу в режиме «Код». [text]{.underline}.

Выделение цветом

Выделите фразу в режиме «Код». [text]{.mark}.

Верхний индекс

Выделите степень в режиме «Код». ^text^.

Нижний индекс

Выделите нижний индекс в режиме «Код». ~text~.

Подчёркивание и выделение цветом используют атрибуты Pandoc, поэтому форматирование попадает в PDF. Используйте эти инструменты вместо добавления «сырых» HTML-тегов в рукопись.

Вставить ссылку

В режиме Код: вставляет [link text](url). Замените оба заполнителя.

В режиме Визуально: открывает Адрес URL ссылки. Введите адрес и примените его к выделенному фрагменту. Используйте Убрать ссылку, чтобы сохранить текст без ссылки.

Вставить изображение

В режиме Код: вставляет ![caption](image-filename). Замените путь и подпись.

В режиме Визуально: открывает Файл изображения. Введите путь внутри проекта, например figures/plot.png, и примените его.

Вставить таблицу

В режиме Код: вставляет три столбца, заголовок и две строки данных. Замените названия столбцов и ячейки.

В режиме Визуально: вставляет редактируемую таблицу тех же начальных размеров.

Нарисовать диаграмму

Открывает конструктор диаграмм в режиме Mermaid. Нарисуйте блок-схему на холсте или отредактируйте код Mermaid, затем выберите Вставить как Mermaid, чтобы добавить её в позицию курсора как ограждённый блок кода mermaid. См. Диаграммы Mermaid.

Сведения о документе

Показывает заголовки, рисунки, таблицы, формулы, метки, цитирования и задачи документа в порядке исходника, каждое со ссылкой на свою строку. Он также читает название, авторов, ключевые слова, дату и аннотацию из front matter и может скопировать их для формы подачи. См. Сведения о документе.

Настройки документа

Меняет класс документа, размер страницы, число колонок, поля, основной шрифт, размер шрифта, язык, межстрочный интервал и нумерацию разделов. Oleafly записывает ваш выбор во front matter в YAML, который читает Pandoc, и добавляет блок front matter, если его не было. См. Настройки документа.

Сведения о проекте

В режиме Код: показывает статистику проекта и сведения о выделенном фрагменте.

В режиме Визуально: показывает статистику поверхности визуального редактирования.

Найти

В режиме Код: открывает поиск в активном файле сочетанием ⌘F / Ctrl+F.

В режиме Визуально: кнопка «Найти» на панели исходника скрыта.

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

Формулы и блоки кода

Вводите строчную математику как $x^2$. Выключную формулу заключите между двумя парами знаков доллара:

$$
\bar{x} = \frac{1}{n}\sum_{i=1}^{n}x_i
$$

Для примера кода заключите код в тройные обратные кавычки и укажите язык после открывающего ограждения. Это конструкции исходника; на панели инструментов Markdown нет отдельной кнопки для формул или ограждённых блоков кода.

Диаграммы Mermaid

Выберите Нарисовать диаграмму на панели инструментов, чтобы создать блок-схему Mermaid в конструкторе диаграмм. Вставить как Mermaid добавляет её как ограждённый блок кода:

```mermaid
flowchart LR
  A[Sample] --> B[Measure]
```

В режиме Оба форматированная сторона рисует блок как диаграмму. PDF требует изображения, поэтому конструктор дополнительно сохраняет готовый PNG по пути figures/mermaid-<hash>.png, и компиляция ставит это изображение на место блока. Поэтому диаграмма появляется и в скомпилированном PDF. Если потом отредактировать блок вручную, в PDF будет показываться код, пока вы снова не вставите диаграмму из конструктора или не сохраните её. См. Mermaid в документах Markdown.

Цитирование и библиография

Импортируйте или создайте references.bib, добавьте bibliography: references.bib в метаданные YAML и ссылайтесь на существующий ключ с помощью [@citation-key]. Pandoc использует библиографию, чтобы создать форматированные цитирования и список литературы.

Найти источники и управлять ими →

Импорт и экспорт

Чтобы сохранить существующий черновик в Markdown, создайте пустой документ Markdown, вставьте черновик в main.md и импортируйте его изображения и библиографию. Отдельный импорт Документ Markdown в библиотеке сейчас преобразует черновик в LaTeX. В разделе Маршруты импорта объясняются оба пути.

Скомпилируйте документ в PDF или используйте Экспорт, чтобы создать Word, HTML, Typst, LaTeX или обычный текст. Чтобы поделиться исходным Markdown и его ресурсами, используйте ZIP с исходником. В разделе Экспорт работы описана последовательность действий и проверки, которые стоит выполнить в преобразованном файле.