diff --git a/doc/en/main-page.md b/doc/en/main-page.md index 67db8c10..0daa4729 100644 --- a/doc/en/main-page.md +++ b/doc/en/main-page.md @@ -14,9 +14,10 @@ Documentation for in-development version 0.26. - [Content-packs](content-packs.md) - [Engine usage recommendations](engine-use-recommendations.md) - [Item properties](item-properties.md) +- [Particles](particles.md) - [Resources (resources.json)](resources.md) - [Rigging](rigging.md) - [Scripting](scripting.md) +- [Text styles](text-styles.md) - [World generator engine](world-generator.md) - [XML UI building](xml-ui-layouts.md) -- [Particles](particles.md) diff --git a/doc/en/text-styles.md b/doc/en/text-styles.md new file mode 100644 index 00000000..93964429 --- /dev/null +++ b/doc/en/text-styles.md @@ -0,0 +1,21 @@ +# Text styles + +A proprietary Markdown dialect is used to mark up text styles. +Formatting works on UI elements: label and textbox, if `markdown="true"` is explicitly specified. + +## Styles + +| Style | Example | Output | +| ------------- | ------------------------ | -------------------------- | +| Bold | `**Bold font**` | **Bold font** | +| Italic | `*Text in italics*` | *Text in italics* | +| Underline | `__Underlined text__` | Underlined text | +| Strikethrough | `~~Strikethrough text~~` | ~~Strikethrough text~~ | + +Styles can be combined. Example: +```md +***__Message__*** using *~~combed~~ combined* styles__~~.~~__ +``` +Output: + +***Message*** using *~~combed~~ combined* styles~~.~~ diff --git a/doc/ru/main-page.md b/doc/ru/main-page.md index 17dbe6ba..10dff292 100644 --- a/doc/ru/main-page.md +++ b/doc/ru/main-page.md @@ -19,4 +19,5 @@ - [Свойства блоков](block-properties.md) - [Свойства предметов](item-properties.md) - [Скриптинг](scripting.md) +- [Стили текста](text-styles.md) - [Частицы](particles.md) diff --git a/doc/ru/text-styles.md b/doc/ru/text-styles.md new file mode 100644 index 00000000..e21560e2 --- /dev/null +++ b/doc/ru/text-styles.md @@ -0,0 +1,21 @@ +# Стили текста + +Для разметки стилей текста используется собственный диалект Markdown. +Форматирование работает на UI элементах: label и textbox, если явно указано `markdown="true"`. + +## Стили + +| Стиль | Пример | Вывод | +| ------------ | ------------------------- | ----------------------- | +| Жирный | `**Жирный шрифт**` | **Жирный шрифт** | +| Курсив | `*Текст курсивом*` | *Текст курсивом* | +| Подчеркнутый | `__Подчеркнутый текст__` | Подчеркнутый | +| Зачеркнутый | `~~Зачеркнутый текст~~` | ~~Зачеркнутый~~ | + +Стили могут объединяться. Пример: +```md +***__Сообщение__***, демонстрирующее *~~обедненные~~ объединенные* стили__~~.~~__ +``` +Вывод: + +***Сообщение***, демонстрирующее *~~обедненные~~ объединенные* стили~~.~~