Типограф
С помощью vale мы частично закрыли историю с типографикой для документации. Но остается другая проблема — неразрывные пробелы. Проставлять их вручную не хочется, это нудно, долго и лениво. К тому же крайне высока вероятность ошибки, например, переписали вы текст и надо снова не забыть проставить неразрывные. Вообще не хочется об этом думать. Ну и типограф это второй эшелон контроля, если vale не справился, то типограф подстрахует.
К тому же не забывайте, у нас есть не только документация, но и другие места, где пригодится типограф: тексты и формы на сайте, макеты в Фигме. Будет здорово, если для всех решений будет использоваться один и тот же типограф, что обеспечит единообразие типографирования.
Вернемся к документации. Нам подходит typograf. Плюсы решения описаны на главной странице:
- гибкость и расширяемость
- UTF-8
- кроссплатформенность
- кроссбраузерность
- поддержка Node.js
- поддержка HTML и XML
- типографирование на лету
- TDD
Опытным путем я выяснил, что Docusurus использует Remark при сборке документации. Поэтому подключить типограф напрямую не получится, нужна надстройка в виде плагина remark-typograf.
Отлично! Задача понятна. Перейдем к написанию промта:
Подключи к проекту типограф: https://github.com/Mavrin/remark-typograf.
Все настройки правил typograf для русского языка оставь без изменений.
Убедись, что типограф обрабатывает папки /blog, /docs, /src/pages.
Если все прошло хорошо, то агент установил необходимые зависимости и добавил новые настройки в config:
Теперь весь контент в указанных папках будет автоматически типографироваться по правилам русского языка при генерации сайта.
Соберите билд npm run build и проверьте, что там собралось:
Отлично! Неразрывные пробелы расставлены, файл оттипографирован. Запустите сборку npm run serve и протестируйте сборку на сайте.