Перейти к содержанию

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

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

Расширенные возможности оформления текста: выделение изменений, подсветка, индексы и клавиши. Что-то пошло не так


⚙ Настройка

Добавьте в mkdocs.yml:

markdown_extensions:
  - pymdownx.critic        # Подсветка изменений
  - pymdownx.caret         # Вставки/индексы
  - pymdownx.keys          # Клавиши
  - pymdownx.mark          # Выделение
  - pymdownx.tilde         # Зачеркивание


🖊 Основные возможности

1. Выделение изменений

Удалить  
Добавить  
ЗаменитьНовый текст  
Выделить  
Комментарий  

Результат:
Удалить
Добавить
ЗаменитьНовый текст
Выделить
Комментарий


2. Блочное выделение


Весь абзац будет  
подсвечен как блок

Результат:
Весь абзац будет
подсвечен как блок


3. Текстовые стили

- ==Выделенный текст==
- ^^Подчёркнутый текст^^
- ~~Зачёркнутый текст~~

Результат:
- Выделенный текст
- Подчёркнутый текст
- Зачёркнутый текст


4. Индексы

H~2~O (подстрочный)  
x^2^ (надстрочный)

Результат:
H2O
x2


5. Обозначение клавиш

++ctrl+alt+del++  
++cmd+option+p++

Результат:
Ctrl+Alt+Del
Cmd+Option+P


💡 Особенности

  • Работает внутри таблиц и списков
  • Поддерживает многострочные блоки
  • Автоматическая стилизация под тему
  • Комбинации клавиш адаптируются под ОС