Quarkdown — современная система вёрстки на базе Markdown, спроектированная ради универсальности. Один проект бесшовно компилируется в готовую к печати книгу, научную статью, базу знаний или интерактивную презентацию. И всё это — через невероятно мощное Тьюринг-полное расширение Markdown, благодаря которому идеи автоматически перетекают в готовый документ.
Выросший как расширение CommonMark и GFM, диалект Quarkdown привносит в Markdown функции и множество других синтаксических расширений.
Вызов функции выглядит так:
.somefunction {arg1} {arg2}
Body argument
Возможности безграничны благодаря постоянно растущей стандартной библиотеке: она предлагает построители раскладки, ввод-вывод, математику, условные операторы и циклы. Мало? Вы можете определять собственные функции и переменные прямо внутри Markdown — и даже собирать библиотеки для других.
.function {greet}
to from:
**Hello, .to** from .from!
.greet {world} from:{iamgio}
Эта встроенная поддержка скриптинга открывает дорогу к сложному и динамическому контенту, недостижимому в обычном Markdown. В сочетании с live-превью, быстрой компиляцией и мощным расширением для VS Code Quarkdown просто делает дело — будь то статья, книга, база знаний или презентация.
Целевые форматы
-
HTML — Plain (непрерывный поток как в Notion/Obsidian), Paged (через paged.js, для статей и книг), Slides (через reveal.js, для презентаций), Docs (для вики и техдокументации).
-
PDF — поддерживаются все типы документов и возможности HTML.
-
Обычный текст.
Нужный тип документа задаётся прямо в исходнике вызовом функции .doctype: {plain} (по умолчанию), {paged}, {slides}, {docs}.
Сравнение
| Quarkdown | LaTeX | Typst | AsciiDoc | MDX | |
|---|---|---|---|---|---|
Лаконичность и читаемость |
да |
нет |
да |
да |
да |
Полный контроль документа |
да |
да |
да |
нет |
нет |
Скриптинг |
да |
частично |
да |
нет |
да |
Экспорт книг/статей |
да |
да |
да |
да |
сторонний |
Экспорт презентаций |
да |
да |
да |
да |
сторонний |
Экспорт статичных сайтов |
да |
нет |
экспериментально |
да |
да |
Экспорт вики/документации |
да |
нет |
нет |
да |
да |
Кривая обучения |
низкая |
высокая |
средняя |
низкая |
низкая |
С чего начать
Установочный скрипт (Linux/macOS):
curl -fsSL https://raw.githubusercontent.com/quarkdown-labs/get-quarkdown/refs/heads/main/install.sh | sudo env "PATH=$PATH" bash
Через Homebrew:
brew install quarkdown-labs/quarkdown/quarkdown
Команда quarkdown create [directory] запускает мастер проекта на основе вопросов. Компиляция — quarkdown c file.qd. Флаги -p (превью) и -w (пересборка при изменениях) вместе дают live-превью; --pdf выдаёт PDF. Есть и интерактивный режим quarkdown repl.
|
Tip
|
Подробности — в вики проекта. |
Концепция и лицензия
Логотип отсылает к иконке Markdown, но то, что можно принять за планету — это на самом деле кварк, точнее down-кварк: элементарная частица, один из главных строительных блоков материи. На этой идее и построен Quarkdown.
По умолчанию Quarkdown и его модули лицензированы под GNU GPLv3; модули CLI (quarkdown-cli) и языкового сервера (quarkdown-lsp) — под GNU AGPLv3.