Документация

Документацию мы ведем в формате MDX - это формат Markdown с поддержкой JSX компонентов.
Для генерации сайта из файлов документации используется Docusaurus.

Как вести документацию?

Установка зависимостей

Для локальной работы с документацией нужно установить Node.js

Также нужно поставить yarn

npm install --global yarn

После чего перейти в директорию с документацией и скачать библиотеки

cd docs
yarn

Редактирование

Все файлы с документацией лежат в каталоге docs/content - переходим туда и редактируем файлы любым удобным редактором. Потом запускаем локальную веб-сервер для просмотра документации в реальном времени

yarn start

Теперь можно просматривать документацию по адресу http://localhost:3000/PhysEdJournal/. Также при редактировании файлов изменения будут сразу отражаться и на сайте.