Abstract¶
Abstract (аннотация) – пишется в теле title, в Jupyter Lab не визиализируется, но на сайте отображается цветным блоком.
При этом, после блока отображается параметр keywords из файла настроек myst.yml – пока keywords убрал (закомментировал).
Синтаксис и расположение abstract в title:
...
venue: MyST Markdown
abstract: |
Символ вертикальной черты `|` обязателен – он говорит YAML-парсеру, что далее
идет многострочный текст.
authors:
...Как убрать отображение Abstract перед блоком интересовался, но всерьез пока не исследовал.
admonitions¶
| Type | RUS | Color | Icon | Type | RUS | Color | Icon |
|---|---|---|---|---|---|---|---|
note | Примечание | 🔵 | ℹ️ | attention | Внимание | 🟠 | 📢 |
important | Важно | 🔵 | ⚡ | caution | Осторожно | 🟠 | ( ! ) |
hint | Подсказка | 🟢 | 💡 | warning | Предупреждение | 🟠 | / ! \ |
seealso | См. также | 🟢 | –> | danger | Опасно | 🔴 | ( ! ) |
tip | Совет | 🟢 | ✏️ | error | Ошибка | 🔴 | ( x ) |
Стандартный
:::{note} Стандартный
:class: dropdown
:open: true
:icon: false
Блок: раскрывающийся (dropdown), открытый, без иконки.
:::Комбинированный
:::{warning .simple .dropdown icon=false open=true} Комбинированный
Блок: комбинированный (simple, dropdown), открытый, без иконки.
:::Dropdown Title
:::{dropdown} Dropdown Title
:open:
Dropdown content
:::div block¶
Шкала размеров текста в блоках :::div формируется через :class:
:::{div}
:class: text-xs
`text-xs` – супер-мелкий (e**X**tra **S**mall)
:::text-xs – супер-мелкий (eXtra Small)
text-sm – уменьшенный (Small)
text-base – обычный стандартный шрифт
text-lg – слегка увеличенный (Large)
text-xl – крупный (eXtra Large)
lead – используется для лид-абзацев (1.25rem)
Этот текст будет мелким, по центру страницы и в рамке со скругленными углами.
:::{div}
:class: text-sm text-center border rounded
Этот текст будет мелким, по центру страницы и в рамке со скругленными углами.
:::I’m off to the right!
# Работает корректно в .md но не в .ipynb
:::{div}
:class: col-gutter-right
I'm off to the right!
:::Аналог abstract c возможностью использовать в теле текста.
Отображается только на сайте. В Jupyter не визуализируется.
# Долго же я искал этот фрейм.
:::{div}
:class: framed
Аналог `abstract` c возможностью использовать в теле текста. \
Отображается только на сайте. В Jupyter *не* визуализируется.
:::
Возможна текстовая подпись
# Изображение тоже можно убрать в такой фрейм
:::{figure} ./media/habr-780х440.png
:class: framed
Возможна текстовая подпись
:::footnotes¶
myst block¶
```{myst}
:::{figure} https://github.com/rowanc1/pics/blob/main/banff-tall.png?raw=true
:align: right
:width: 40%
The picture would look better if it is `:align: center`-ed!
:::
```card¶
Обрамление с помощью директивы card
:::{card}
Обрамление с помощью директивы `card`
:::The Header
Card content
# Реквизиты
:::{card} Card title
:header: The _Header_
:footer: Footer
Card contentThe entire card can be clicked to navigate to mystmd.org.
# Кликабельная карта
:::{card} Clickable Card
:link: https://mystmd.org
The entire card can be clicked to navigate to `mystmd.org`.glossary¶
- MyST
- An amazing markup language that supports glossaries
:::{glossary}
MyST
: An amazing markup language that supports glossaries
:::list-table¶
Abbreviations are also great structured data for screen-readers!