Skip to main content

Как пользоваться Markdown (CommonMark) в нашем wiki

Эта страница — краткая “шпаргалка” по оформлению страниц в нашей wiki, где текст пишется в Markdown по CommonMark.

Базовые правила

  • Пиши текст простыми короткими предложениями.
  • Делай страницу сканируемой: заголовки + списки + таблицы.
  • Один раздел = одна мысль. Не делай “стену текста”.

Заголовки

Используй ## / ### / #### для структуры.

## Раздел
### Подраздел
#### Под‑подраздел

Жирный, курсив, код

**жирный**
*курсив*
`код/поле/адрес`

Ссылки

[текст ссылки](https://example.com)

Если нужно показать “голую” ссылку (редко):

`https://example.com`

Списки

Маркированный список:

- пункт 1
- пункт 2
  - подпункт

Нумерованный:

1. шаг 1
2. шаг 2
3. шаг 3

Цитаты / примечания

> Это важное примечание.
> Можно в две строки.

Таблицы

Минимальный шаблон:

| Поле | Значение |
|---|---|
| Название | [ ] |
| Сайт | [ ] |

Подсказки:

  • Разделитель |---|---| обязателен.
  • В ячейки можно писать **жирный**, ссылки и код.

Код и “сырые” куски текста

Код‑блок:

```text
строка 1
строка 2

Если это конкретный язык (например, JSON), можно указать его:

```markdown
```json
{ "key": "value" }

## Картинки

Если есть прямой URL картинки:

```markdown
![описание](https://example.com/image.png)

Если файл загружен в wiki — используй ссылку/вставку, которую даёт wiki при загрузке.

Разрывы строк и абзацы

  • Новый абзац — это пустая строка между абзацами.
  • Если нужен перенос строки внутри абзаца — поставь два пробела в конце строки:
Первая строка.␠␠
Вторая строка.

Встроенный HTML (используем осторожно)

Сворачиваемый блок “Подробнее”

Используем для длинных деталей/доказательств, чтобы не перегружать “первый экран”.

<details>
<summary><b>Подробнее</b></summary>

Тут может быть текст, списки и таблицы.

</details>

Якоря и быстрые ссылки по странице

Якорь:

<a id="ai-thesis-fit"></a>

Ссылка на якорь:

[Перейти к AI‑соответствию](#ai-thesis-fit)

Плейсхолдеры в шаблонах

В шаблонах мы используем:

  • [ ] — “заполнить”
  • unknown / — “неизвестно/не применимо” (если это осмысленно)
  • YYYY‑MM‑DD — формат дат
  • Tier‑1/2/3 — уровень источника (доказательства/контекст/шум)

Частые ошибки

  • Смешивать инфобокс и описание: инфобокс — только короткие факты; объяснения — в теле страницы.
  • Писать без источников там, где источник должен быть.
  • Перегружать “первый экран”: длинные детали лучше уводить в <details>.
  • Использовать “финансовый язык” (советы купить/продать/держать, прогнозы) — у нас это запрещено; пишем только факты/риски/что перепроверять.

Мини‑чеклист перед публикацией

  • Есть ли 1–2 строки, которые объясняют “что это”?
  • Есть ли ссылки на первоисточники?
  • В таблицах нет пустых “непонятных” полей (везде либо значение, либо unknown/—)?
  • Дата Last verified проставлена?