Оформление кода

[tabuna]

Мотивация

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

Существует перспективная библиотека под названием TempestPHP, которую мы теоретически можем использовать. Однако на данный момент она не кажется оптимальным выбором. Вот пример проблемы, с которой я столкнулся при тестировании этой библиотеки: ссылка на issue #73.

В качестве альтернативы я рассмотрел библиотеку https://github.com/scrivo/highlight.php, которая показалась мне более приемлемой. Она обеспечивает подсветку синтаксиса не только для PHP, но и для других языков, таких как Blade или Vue, которые так же используются в документации. Но она не решает проблемы с diff или фокусировкой.

Еще одним вариантом является использование shiki.style. Однако, на клиентской стороне это решение весит почти 10 мегабайт, что является излишним. Его использование возможно только при запуске в фоновом режиме, однако это значительно усложняет процесс внесения первого вклада на сайте для новых разработчиков.