1.14.5

Translate

Installation

Docusaurus был разработан с нуля с целью быть легким в установке и использовании для создания и быстрого запуска вашего веб-сайта.

Important Note: If you are setting up a new Docusaurus website for a Facebook Open Source project, we highly encourage you to use Docusaurus 2 instead.

Установка Docusaurus

We have created a helpful script that will get all of the infrastructure set up for you:

  1. Убедитесь, что последняя версия Node уже установлена. Также мы рекомендуем установить Yarn.

    You have to be on Node >= 10.9.0 and Yarn >= 1.5.

  2. Создайте проект, если он еще не существует, и перейдите в его корневой каталог.

    В этом каталоге вами будут созданы документы. The root directory may contain other files. The Docusaurus installation script will create two new directories: docs and website.

    Обычно, в качестве места расположения вашего сайта на Docusaurus будет использован либо существующий, либо вновь созданный проект GitHub, но это не единственный способ использования Docusaurus.

  3. Запустите команду установки Docusaurus: npx docusaurus-init.

    Если у вас не установлен Node 8.2+ или вы желаете установить Docusaurus глобально, выполните yarn global add docusaurus-init или npm install --global docusaurus-init. После этого выполните docusaurus-init.

Проверка установки

Наряду с уже существующими файлами и каталогами, корневой каталог теперь будет содержать структуру, похожую на:

root-directory
├── Dockerfile
├── README.md
├── docker-compose.yml
├── docs
│   ├── doc1.md
│   ├── doc2.md
│   ├── doc3.md
│   ├── exampledoc4.md
│   └── exampledoc5.md
└── website
    ├── blog
    │   ├── 2016-03-11-blog-post.md
    │   ├── 2017-04-10-blog-post-two.md
    │   ├── 2017-09-25-testing-rss.md
    │   ├── 2017-09-26-adding-rss.md
    │   └── 2017-10-24-new-version-1.0.0.md
    ├── core
    │   └── Footer.js
    ├── package.json
    ├── pages
    ├── sidebars.json
    ├── siteConfig.js
    └── static
 
Text
XPath: /pre/code

This installation creates some Docker files that are not necessary to run docusaurus. They may be deleted without issue in the interest of saving space. For more information on Docker, please see the Docker documentation.

Запуск веб-сайта

After running the Docusaurus initialization script, docusaurus-init as described in the Installation section, you will have a runnable, example website to use as your site's base. Для этого:

  1. cd website

  2. From within the website directory, run the local web server using yarn start or npm start.

  3. Load the example site at http://localhost:3000 if it did not already open automatically. Если порт 3000 уже занят, то будет использован другой порт. Проверьте сообщения в консоли, чтобы увидеть который именно.

    Вы должны увидеть главную страницу запущенного примера веб-сайта. Также вы можете запустить LiveReload сервер, чтобы любые изменения в документах и файлах в каталоге website приводили к обновлению страницы. Для вашего сайта будут выбраны случайным образом основном и второстепенный цвета.

Использование прокси

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

SET NO_PROXY=localhost
yarn start (or npm run start)

Обновление вашей версии Docusaurus

В любое время после установки Docusaurus вы можете проверить его текущую версию, если перейдете в каталог website и наберете в терминале yarn outdated docusaurus или npm outdated docusaurus.

Вы увидите нечто вроде этого:

$ yarn outdated
Using globally installed version of Yarn
yarn outdated v1.5.1
warning package.json: No license field
warning No license field
info Color legend :
 "<red>"    : Major Update backward-incompatible updates
 "<yellow>" : Minor Update backward-compatible features
 "<green>"  : Patch Update backward-compatible bug fixes
Package    Current Wanted Latest Package Type    URL
docusaurus 1.0.9   1.2.0  1.2.0  devDependencies https://github.com/facebook/docusaurus#readme
✨  Done in 0.41s.

Если не были выведены какие-либо значимые данные о версии после выполнения команды outdated, значит версия самая свежая.

Вы можете обновить Docusaurus до последней версии, выполнив в терминале:

yarn upgrade docusaurus --latest

или

npm update docusaurus

Если после обновления вы получаете ошибки, попробуйте очистить ваш кэш Babel (обычно он расположен во временном каталоге) или запустите сервер Docusaurus (например, yarn start) с параметром окружения BABEL_DISABLE_CACHE=1.

Site Preparation →