Помощь с документацией

Хотите помочь с документацией Rapira? Отлично. Эта страница — живой обзор всего, что умеет движок документации: каждый блок ниже собран из той же разметки Markdown, которую пишете вы. Держите её под рукой как шпаргалку, когда работаете над страницами.

Блоки-выноски

Оберните текст в контейнер :::, чтобы получить цветную выноску с иконкой:

::: tip
Полезный совет, который стоит выделить.
:::
::: info
Нейтральная справочная информация.
:::
::: warning
То, с чем стоит быть осторожнее.
:::
::: danger
Реальный риск — действуйте внимательно.
:::

Полезный совет, который стоит выделить.

Нейтральная справочная информация.

То, с чем стоит быть осторожнее.

Реальный риск — действуйте внимательно.

Сразу после типа можно задать свой заголовок:

Совет

Задайте блоку свой заголовок, когда стандартной подписи мало.

Блоки кода

Код в ограждённом блоке получает подсветку синтаксиса, метку языка и кнопку копирования:

fn main() {
    println!("Hello, Rapira!");
}

Обратите внимание читателя на нужные строки — подсветите их, поставьте фокус или покажите изменения:

fn main() {
    let answer = 42;
    println!("The answer is {answer}"); // эта строка подсвечена
}

fn main() {
    let ready = true;      
    println!("{ready}");
}

fn setup() {
    let retries = 1;       
    let retries = 3;       
}

Соберите разные варианты команды во вкладки:

npm

npm install

pnpm

pnpm install

yarn

yarn

Диаграммы

Блок mermaid превращается в диаграмму:

Таблицы и бейджи

Обычные таблицы Markdown работают из коробки:

Возможность	В комплекте
Выноски	✅
Группы кода	✅
Mermaid	✅
FAQ-спойлеры	✅

Встроенные бейджи удобны для меток статуса: новое бета устарело.

Frontmatter страницы

Опции страницы задаются в YAML-блоке в самом начале файла:

---
title: Свой заголовок     # переопределяет H1 для <title> / og:title
description: Краткое описание # meta description и og:description
outline: [2, 3]           # меню «На этой странице» — см. ниже
aside: false              # полностью скрыть правую колонку
lastUpdated: false        # скрыть отметку «Обновлено» на этой странице
editLink: false           # скрыть ссылку «Редактировать эту страницу»
prev: false               # скрыть ссылку «Назад» в подвале
next:                     # либо переименовать / перенаправить ссылку
  text: Блог
  link: /ru/blog/
faqLevel: 2               # где собираются блоки ::: question (см. выше)
---

outline управляет оглавлением «На этой странице» справа:

outline: [2, 3]   # по умолчанию — H2 и H3
outline: deep     # все уровни, H2–H6
outline: 2        # только H2
outline: false    # скрыть

layout: home — для лендинга, layout: page — для «голой» страницы без бокового меню и оглавления; обычные страницы используют layout doc по умолчанию.

Вопросы (FAQ-спойлеры)

Напишите блок ::: question в любом месте страницы:

::: question Как запустить сайт локально?
Один раз `npm install`, затем `npm run dev`.
:::

Движок собирает все вопросы из текста и складывает их в раскрывающиеся спойлеры в конце раздела — как раз такие, как ниже.

Куда именно они попадут — решаете вы: задайте faqLevel во frontmatter страницы:

---
faqLevel: 1       # по умолчанию — в конце каждого раздела H1 (обычно это конец страницы)
faqLevel: 2       # в конце каждого раздела H2
faqLevel: 0       # в самом конце страницы, без учёта заголовков
faqLevel: false   # без группировки — каждый вопрос остаётся на месте, где вы его написали
---

Как запустить сайт локально?

Выполните один раз npm install, затем npm run dev и откройте локальный адрес, который он покажет.

Где лежат переводы?

У каждого языка своя папка — ru/, es/, zh/, pl/ — с той же структурой, что и английская версия. Английский — источник правды.