Справка по MDX

Автор: Phenomen

1 января 2023 г.

MDX — это формат документов, основанный на популярном Markdown и расширенный возможностями JSX (JavaScript eXpressions), вроде возможности использовать JavaScript выражения и импортировать компоненты.

Markdown (MD)

Весь стандартный синтаксис MD поддерживается MDX.

# Заголовок 1

## Заголовок 2

### Заголовок 3

#### Заголовок 4

Обычный, **полужирный**, и _курсив_.

Обычный, полужирный, и курсив.

[Внутренняя ссылка](/articles)
[Внешняя ссылка](https://discord.gg/yrJqvCqU3w)

Внутренняя ссылка

Внешняя ссылка

![Изображение](/images/decoration/logo-small.webp)

- Маркированный список
  1. Элемент второго уровня
- Маркированный список

1. Нумерованный список
1. Нумерованный список
   - Элемент второго уровня

Маркированный список
1. Элемент второго уровня
Маркированный список

Нумерованный список
Нумерованный список
- Элемент второго уровня

> Ipsum tempor eirmod et dolore ipsum invidunt duo. Tempor gubergren sanctus et sit at eirmod.

горизонтальная линия: ---

Ipsum tempor eirmod et dolore ipsum invidunt duo. Tempor gubergren sanctus et sit at eirmod.

GitHub Flavored Markdown (GFM)

Дополнение к Markdown, добавляющее форматирование с GitHub. Не все возможности GFM поддерживаются MDX.

Frontmatter

Во frontmatter содержаться метаданные страницы. Он указывается в самом начале содержимого файла в формате YAML и выделяяеся с двух сторон ---. Для различных документов frontmatter может быть разным в зависимости от требуемых метаданных. В Astro при использовании Content Collections формат каждой коллекции задаётся в src/content/config.ts. Frontmatter этой страницы:

---
title: Справка по MDX
description: В этом руководстве вы узнаете об основах формата MDX, дополнительном синтаксисе и компонентах.
date: 'Jan 13 2023'
cover: '~assets/covers/FsO602AXsAIqBzR.png'
author: Алекс «Phenomen» Василенко
---

Таблицы

| a                | b                |                 c |      d      |
| ---------------- | :--------------- | ----------------: | :---------: |
| по умолчанию     | по левому краю   |   по правому краю |  по центру  |
| **по умолчанию** | _по левому краю_ | ~по правому краю~ | `по центру` |

a	b	c	d
по умолчанию	по левому краю	по правому краю	по центру
по умолчанию	по левому краю	~~по правому краю~~	`по центру`

Автоматические ссылки

www.example.com, https://example.com, и contact@example.com.

www.example.com, https://example.com, и contact@example.com.

Сноски

Чертополох[^1] и крыжовник[^2].

[^1]: Описание чертополоха.
[^2]: Описание крыжовника.

Чертополох¹ и крыжовник².

Зачеркивание

~одна~ тильда.

~~одна~~ тильда.

JavaScript Expressions (JSX)

Любые JavaScript выражения можно добавлять внутри фигурных скобок { ... }. Не рекомендуется использовать динамические или случайные функции, т.к. во время сборки сайта всё преобразуется в статичные страницы.

Pi равно { Math.PI },
а два 2 + 2 { 2 + 2 === 5 ? "равно" : "не равно" } 5,
хотя на d20 выпало { Math.floor(Math.random() \* 20) }

{
	/* комментарий, не отображаемый на странице */
}

import Creature from '~components/Creature.astro';

<Creature id="goblin" />

Phenomenal Markdown (PMD)

Расширеное форматирование, созданное для этого сайта.

Подсветка

В GFM этот синтаксис обрамляет текст обратными кавычками с двух сторон, чтобы выделить код или переменные. Вместо этого в PMD текст подсвечивается особым фоном, если нужно указать на что-то очень важное.

`выделенный текст`

Блок

Обособленные блоки для заметного выделения секций текста (в дизайне их называют aside или callout). Это могут быть заметки и предупреждения. Есть четыре варианта блоков, которые можно указывать через свойство v: ivory, gold, wave, crimson. Если не указывать ничего, то будет использован вариант ivory.

<Aside v="ivory|gold|wave|crimson">

Текст внутри блока также _поддерживает_ **Markdown**.

</Aside>

Ссылка

<Link id="translations/slyflourish" />

<Link id="translations/slyflourish" title="Свой заголовок для ссылки" />

Перевод Ленивого Мастера Подземелий

Свой заголовок для ссылки

Стих

Компонент стиха выравнивает текст по центру и делает его курсивом.

<Verse>

#### Слово

Молчат гробницы, мумии и кости, —  
Лишь слову жизнь дана:  
Из древней тьмы, на мировом погосте,  
Звучат лишь Письмена.

И нет у нас иного достоянья!  
Умейте же беречь  
Хоть в меру сил, в дни злобы и страданья,  
Наш дар бессмертный — речь.

</Verse>

Слово

Молчат гробницы, мумии и кости, —
Лишь слову жизнь дана:
Из древней тьмы, на мировом погосте,
Звучат лишь Письмена.

И нет у нас иного достоянья!
Умейте же беречь
Хоть в меру сил, в дни злобы и страданья,
Наш дар бессмертный — речь.

Компоненты 5E

Существа, предметы, и заклинания для 5E. Инструкцию по использованию этих компонентов смотрите в Написание статей.

Манекен

небольшой / конструкция (кукла) / хаотичное доброе

Класс зашиты 17 (естественный доспех)

Хиты 7 [12] (2d6)

Скорость 30 футов, ползание 20 футов

СИЛ 8 (-1)

ЛОВ 14 (2)

ТЕЛ 10 (0)

ИНТ 10 (0)

МУД 8 (-1)

ХАР 8 (-1)

Уязвимость к урону список уязвимостей

Устойчивость к урону список устойчивостей

Иммунитет к урону список невосприимчивостей

Иммунитет к состояниям список состояний

Чувства пассивное 12

Языки общий, гоблинский

Опасность 1/2 Бонус владения +2

Описание

Goblins are small, black-hearted, selfish humanoids that lair in caves, abandoned mines, despoiled dungeons, and other dismal settings. Individually weak, goblins gather in large-sometimes overwhelming-numbers. They crave power and regularly abuse whatever authority they obtain.

Goblinoids. Goblins belong to a family of creatures called goblinoids. Their larger cousins, hobgoblins and bugbears, like to bully goblins into submission. Goblins are lazy and undisciplined, making them poor servants, laborers, and guards. Malicious Glee. Motivated by greed and malice, goblins can’t help but celebrate the few times they have the upper hand. They dance, caper with sheer joy when victory is theirs. Once their revels have ended, goblins delight in the torment of other creatures and embrace all manner of wickedness.

Leaders and Followers. Goblins are ruled by the strongest or smartest among them. A goblin boss might command a single lair, while a goblin king or queen (who is nothing more than a glorified goblin boss) rules hundreds of goblins, spread out among multiple lairs to ensure the tribe’s survival. Goblin bosses are easily ousted, and many goblin tribes are taken over by hobgoblin warlords or bugbear chiefs.

Challenging Lairs. Goblins festoon their lairs with alarms designed to signal the arrival of intruders. Those lairs are also riddled with narrow tunnels and bolt-holes that human-sized creatures can’t navigate, but which goblins can crawl through with ease, allowing them to flee or to circle around and surprise their enemies. Rat Keepers and Wolf Riders. Goblins have an affinity for rats and wolves, raising them to serve as companions and mounts, respectively. Like rats, goblins shun sunlight and sleep underground during the day. Like wolves, they are pack hunters, made bolder by their numbers. When they hunt from the backs of wolves, goblins use hit-and-run attacks.

Worshipers of Maglubiyet. Maglubiyet the Mighty One, the Lord of Depths and Darkness, is the greater god of goblinoids. Envisioned by most goblins as an eleven-foot-tall battle-scarred goblin with black skin and fire erupting from his eyes, he is worshiped not out of adoration but fear. Goblins believe that when they die in battle, their spirits join the ranks of Maglubiyet’s army on the plane of Acheron. This is a “privilege” that most goblins dread, fearing the Mighty One’s eternal tyranny even more than death.

Описание чертополоха. ↩
Описание крыжовника. ↩

Если вам понравилась эта статья или у вас есть комментарии, присоединяйтесь к дискуссии в канале Telegram или сервере в Discord.

Помогите распространить статью, сделав репост

Telegram Facebook Twitter