Skip to main content

Что дальше?

MDX

Первая версия языка markdown была опубликована в 2004 году. С тех пор появились новые языки, расширяющие его. Самое распространённое расширение - это язык mdx. Создатели позиционируют язык как markdown для эры компонентов.

Программирование компонентами исходит из логики, что разработчики раз за разом создают одни и те же элементы управления, диалоги. Компонентный подход говорит, что всю логику создания таких компонентов можно скрыть от пользователя, а ему оставить только нужные команды.

Поэтому вместо форматирования текста несколько слов могут указать интерпретатору создать интерактивный диалог, особым образом оформленный блок и много чего ещё. Если заинтересовало, предлагаю вам изучить их документацию.

Правда, там всё на английском.

Docusaurus

Следуя такому подходу группа программистов создала целый фреймворк для работы с документацией. По сути, проблема заключается не только в том, чтобы изложить свои мысли при помощи языка markdown. Эту документацию нужно ещё загрузить на сервер и написать программу, которая будет красиво её отображать. Эту задачу решает фреймворк Docusaurus.

Фреймворк - это по сути готовая программа, которая уже может быть собрана и запущена. Как в своё время программисты увидели в бинарных кодах одни и те же последовательности, так и их последователи увидели в сайтах да и просто программах такие же последовательности команд, но уже на уровне библиотек, модулей, их связей.

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

Docusaurus - это фреймворк для создания документации, написанный на ReactJS. у него есть полная документация на английском и укороченная, она находится в последних трёх разделах и начинается с "Docusaurus - ...".

Укороченная документация добавляется при развёртывании нового сайта из готового шаблона. Она тоже пока что только на английском, я неспешно буду её переводить.