Установка Docusaurus

Перейдите в репозиторий, нажмите на кнопку Code и скопируйте https-ссылку:

Запустите Cursor, нажмите на кнопку Clone repo и вставьте ссылку:

Нажмите Enter, выберите место размещения репозитория на диске и откройте проект по кнопке Open:

В главном меню прейдите Terminal → New Terminal:

Вставьте в терминал команду для установки Docusaurus и нажмите Enter:

npx create-docusaurus@latest my-website classic --javascript

Супер! Docusaurus установлен. Но он установился во вложенную папку, давайте вынесем все файлы в корень нашего проекта. Выполните команду:

mv my-website/* . && mv my-website/.* . 2>/dev/null || true

А теперь избавимся от папки:

rm -rf my-website

Давайте запустим проект:

npm start

Успех! Система откроет браузер и запустит Docusaurus по адресу http://localhost:3000/ в базовой настройке:

Вернитесь в Cursor и обратите внимание на Terminal, там будет запись о том, что сервер сейчас запущен:

Документация будет доступна по адресу http://localhost:3000/ до тех пор, пока сервер запущен. Если его остановить или выключить компьютер, то документация станет недоступна.

Чтобы ее запустить надо снова выполнить команду npm start, а чтобы остановить сервер — нажать сочетание клавиш Control + C. Потренируйтесь.

Важно! Чтобы отдавать команды в терминале, надо остановить сервер или создать еще один терминал.

Давайте посмотрим, что внутри у Docusaurus.

Папка blog соответствует разделу Blog на сайте:

Папка docs соответствует разделу Tutorial:

Папка src хранит в себе отдельные страницы, css-файлы и компоненты:

Папка static хранит исходники общих для всего сайта картинок:

Файл .gitignore содержит список игнорируемых файлов и каталогов. Эти элементы исключены из отслеживания Git и не попадут в репозиторий:

docusaurus.config.js, главный файл конфигурации генератора Docusaurus:

package.json хранит список всех зависимостей или компонентов, которые нужны для запуска сайта:

sidebars.js отвечает за настройку сайдбара, например, в разделе Tutorial:

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