Что такое Markdown

Markdown — это легкий язык разметки, используемый для простого и эффективного форматирования текста.Он был создан в 2004 году Джоном Грубером и Аароном Шварцем с целью сделать простые текстовые документы визуально привлекательными и легко конвертируемыми в структурированные форматы, такие как HTML.Markdown широко используется в документации, блогах, электронной почте и репозиториях кода, таких как GitHub.

Этот язык разметки не имеет никакого отношения к игре Mordhau, ее разработке или созданию модов для нее.Это просто область знаний, которая существует независимо и имеет множество применений в различных областях.Мы объясняем это здесь исключительно потому, что используем его для внесения вклада в документацию игры Mordhau, через которую вы читаете эту страницу.

INFO

Информация для тех, кто не знаком с программированием или веб-сайтами:
HTML также является языком разметки и базовой структурой.для всех веб-сайтов.На этой странице вам не требуется изучать или понимать ее, если вы намерены только внести свой вклад в документацию Mordhau.Вам просто нужно выучить Markdown, который в конечном итоге преобразуется в HTML-код.

Мы не ставим своей целью объяснить сложности программирования или погрузить вас в мир, полный технических подробностей.Наша единственная цель — направить ваше внимание только на документацию Mordhau!Независимо от того, являетесь ли вы новичком в языках программирования или вообще не разбираетесь в них, мы стремимся максимально упростить вам задачу.

Где используется Markdown?

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

1. Техническая документация:
   Markdown широко используется для написания файлов README в таких репозиториях, как GitHub, GitLab иБитбакет.
2. Платформы для ведения блогов:
   Многие платформы, такие как Medium или Jekyll, поддерживают Markdown, что позволяет легко создавать хорошо отформатированные сообщения.
3. Системы управления контентом (CMS):
   Markdown часто используется в генераторах статических сайтов, таких как Hugo и Gatsby.
4. Электронная почта и обмен сообщениями:
   Markdown помогает форматировать чистые и профессиональные электронные письма или сообщения чата, особенно в таких инструментах, как Slack или Discord.
5. Приложения для создания заметок:
   Популярные инструменты, такие как Notion, Obsidian и Evernote, поддерживают Markdown для эффективной организации заметок.
6. Образовательные платформы:
   Markdown используется в вики и учебных пособиях для предоставления четкой, структурированной информации.

Как работает Markdown?

Markdown использует синтаксис обычного текста со специальными символами для определения форматирования.Вот несколько примеров:

1- Заголовки:

# Heading 1

## Heading 2

### Heading 3

Заголовок — это строка, начинающаяся с одного до шести.Символы #.Один # — заголовок страницы, ## — раздел, ### — подраздел.Оставьте после него пустую строку.

2- Акцент:

*italic* or _italic_
**bold** or __bold__
***bold italic***
~~struck through~~

3- Списки:

- first item
- second item
  - a nested item, indented by two spaces

1. numbered
2. list
3. of things

Нумерованные списки перенумеровываются, чтобы вы могли писать.1. в каждой строке и Markdown по-прежнему будут считаться правильно.

4- Ссылки:

[text people click](https://example.com)

5- Изображения:

![description of the image](/path/to/image.webp)

Описание в квадратных скобках — это то, что объявляют программы чтения с экрана и что показывает, если изображение не загружается, поэтому напишите там что-нибудь реальное.

6- Код:

Заключите несколько слов в одинарные обратные кавычки, чтобы пометить их как код — полезно для имен файлов, команд и ключей конфигурации.Если что-то длиннее, используйте три обратных кавычки и назовите язык:

```bash
node -v
```

7- Котировки:

> Anything after a > is a quote block.

8- Таблицы:

| Setting | Meaning |
| --- | --- |
| MaxSlots | How many players fit on the server |
| ServerName | The name shown in the browser |

Дефисы во второй строке превращают ее в таблицу.Столбцы не обязательно должны совпадать в источнике.

Чего не делает Markdown

Markdown намеренно не имеет синтаксиса для цветов, шрифтов, выравнивания текста или макета.В этом вся суть — документ описывает его структуру, а сайт решает, как структура будет выглядеть.Если вы обнаруживаете, что боретесь с этим, вы обычно вместо этого пытаетесь сделать что-то, с чем должна справиться тема.

Далее

Приведенный выше синтаксис является стандартным для Markdown и работает где угодно.Этот сайт также добавляет несколькодополнительные элементы поверх него — выноски, блоки кода с вкладками, заголовок страницы.Они описаны в Как использовать Markdown.