Обработка текста

Замена эмодзи на иконки #

Если вы пишете документацию для интерфейса со множеством иконок, исходный файл на Markdown или ReST может быстро стать неудобным для восприятия из-за частых вставок изображений. Чтобы упростить работу с таким текстом, вы можете использовать более простые и наглядные символы эмодзи: например, символ ⚠️ вместо ![](/icons/warning.png). При сборке документации Собирака автоматически подставит в текст нужное изображение в соответствии с настройкой content.emoji_replacements.

Предположим, в вашей документации присутствует такой текст с большим количеством иконок из описываемого интерфейса:

Сообщения о некритических ошибках отмечаются значком ![](/icons/warning.png), а о критических — значком ![](/icons/error.png). Чтобы скрыть все сообщения, нажмите кнопку ![](/icons/close.png).

Вы можете заменить каждое изображение на похожий по смыслу эмодзи:

Сообщения о некритических ошибках отмечаются значком ⚠️, а о критических — значком ⛔. Чтобы скрыть все сообщения, нажмите кнопку ✖️.

В выходном формате документации вместо эмодзи будут использованы ваши изображения. Ниже показан соответствующий фрагмент конфигурации.

content:
  emoji_replacements:
    ⚠️: /icons/warning.png
    ⛔: /icons/error.png
    ✖️: /icons/close.png