Пример страницы документации

Эта страница демонстрирует возможности, доступные в этом сайте документации на Mintlify. Лучше всего просмотреть исходный raw-код этой страницы на GitHub, чтобы увидеть, как написаны материалы.

Форматирование текста

жирный, курсив, ~~зачёркнутый~~, inline code. Верхний индекс: обычный^TM, нижний индекс: обычный_прим.

Ссылки

Внутренняя ссылка Внешняя ссылка

Цитаты

Это цитата. Второй абзац цитаты.

Callouts

Общая информация и примечания.

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

Полезные советы и хитрости.

Следите за потенциальными проблемами.

Критическая информация, требующая внимания.

Успешные результаты и подтверждения.

Произвольный callout с иконкой и цветом

Badge

Обычный Успех Beta Избранное Контурный

Accordion

Нажмите, чтобы развернуть

Скрытое содержимое, которое можно раскрыть по запросу.

Console.WriteLine("Изнутри аккордеона");

Раздел 1

Контент раздела 1.

Раздел 2

Контент раздела 2.

Cards

Карточка с иконкой

Описание карточки. Нажмите, чтобы перейти.

Горизонтальная карточка

Компактный вариант.

Image card

Карточка с изображением.

Columns

Колонка 1

Контент первой колонки.

Колонка 2

Контент второй колонки.

Колонка AТекст в левой колонке.

Колонка BТекст в центральной колонке.

Колонка CТекст в правой колонке.

Блоки кода

public sealed class GreeterSystem : EntitySystem
{
    public void GreetEveryone(string message)
    {
        Logger.Info(message);
    }
}

С подсветкой строк:

public sealed class GreeterSystem : EntitySystem
{
    public void GreetEveryone(string message)
    {
        Logger.Info(message);
    }
}

С номерами строк и заголовком:

GreeterSystem.cs

public sealed class GreeterSystem : EntitySystem
{
    public void GreetEveryone(string message)
    {
        Logger.Info(message);
    }
}

Сворачиваемый:

public sealed class GreeterSystem : EntitySystem
{
    public void GreetEveryone(string message)
    {
        Logger.Info(message);
    }

    public void GreetEveryoneDelayed(string message, TimeSpan delay)
    {
        // Очень длинная implementation...
        // Которая может быть свёрнута
        // Для экономии места на странице
    }
}

Дифф:

public void OldMethod() 
public void NewMethod() 
{
    Logger.Info("Hello!"); 
}

CodeGroup

Console.WriteLine("Hello!");

print("Hello!")

- type: Greeter
  message: "Hello!"

Таблицы

Свойство	Тип	Описание
Name	`string`	Имя пользователя
Age	`int`	Возраст
Joined	`bool`	Подтверждение регистрации

С выравниванием:

По левому краю	По центру	По правому краю
значение	значение	значение

Списки

Первый пункт
Второй пункт
- Вложенный пункт
- Ещё один
Третий пункт

Steps

Установка

Установите Mintlify CLI.

Запуск

Запустите dev-сервер.

Проверка

Откройте браузер.

Tabs

Windows
Linux
macOS

Инструкция для Windows.

Tiles

Редактирование

Как вносить правки

— это бесплатная игра с открытым исходным кодом.

Tree

Content

Server.cs

Client

RobustToolbox

README.md

Frame

Yosemite Valley — Yosemite National Park

Иконки

Математические выражения

Блочный LaTeX:

\mu = \frac{1}{N} \sum_{i=0} x_i

Строчный LaTeX:

\LaTeX

​Форматирование текста

​Ссылки

​Цитаты

​Callouts

​Badge

​Accordion

​Cards

Карточка с иконкой

Горизонтальная карточка

Image card

​Columns

Колонка 1

Колонка 2

​Блоки кода

​CodeGroup

​Таблицы

​Списки

​Steps

​Tabs

​Tiles

​Tooltip

​Tree

​Frame

​Иконки

​Математические выражения

​Mermaid

​Visibility

​Разделитель

​Комментарий (не отображается)

Форматирование текста

Ссылки

Цитаты

Callouts

Badge

Accordion

Cards

Columns

Блоки кода

CodeGroup

Таблицы

Списки

Steps

Tabs

Tiles

Tooltip

Tree

Frame

Иконки

Математические выражения

Mermaid

Visibility

Разделитель

Комментарий (не отображается)