Skip to main content

Установка Docusaurus Ubuntu 24

docusaurus_live.gif

ДЕМО: ДЕМО Docusaurus

Работает на Markdown

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

Для установки Docusaurus вам понадобится установленный Node.js и менеджер пакетов (npm или Yarn). Затем, в директории вашего проекта, выполните команду npx docusaurus init для создания нового сайта Docusaurus. После установки вы можете запускать сайт локально с помощью npm start или yarn start. 
Шаги по установке:
Убедитесь, что у вас установлен Node.js и npm (или Yarn): Docusaurus требует наличия Node.js на вашем компьютере. Если у вас его нет, скачайте и установите последнюю версию с официального сайта Node.js.
Создайте новую директорию для вашего проекта: (если это необходимо) и перейдите в нее в терминале.
Инициализируйте новый сайт Docusaurus: с помощью следующей команды: 

npx docusaurus init

Эта команда установит все необходимые зависимости и создаст базовую структуру Docusaurus в вашей директории. 
Запустите ваш локальный сайт Docusaurus: для просмотра и тестирования:

npm start

# или, если вы используете Yarn
    

yarn start


После выполнения этой команды ваш сайт будет запущен на локальном сервере, и вы сможете просмотреть его в своем браузере, как правило, по адресу http://localhost:3000. 
Дополнительные советы:
Используйте команду init с указанием имени проекта: Для создания сайта Docusaurus с определенным именем проекта вы можете использовать:

npx docusaurus init <имя-проекта>

Это создаст папку с указанным именем и поместит туда ваш новый сайт Docusaurus. 
Используйте команды run: Docusaurus предоставляет набор скриптов для создания, обслуживания и развертывания вашего веб-сайта. Эти скрипты можно вызывать с помощью команды run в npm или Yarn, например, npm run build для сборки сайта или npm run deploy для развертывания.