1.14.4

Translate

Installation

Docusaurus was designed from the ground up to be easily installed and used to get your website up and running quickly.

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.

도큐사우루스 설치하기

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 >= 8.x and Yarn >= 1.5.

  2. Create a project, if none exists, and change your directory to this project's root.

    이 디렉토리에 문서를 만들겁니다. The root directory may contain other files. The Docusaurus installation script will create two new directories: docs and website.

    일반적인 경우 기존에 만들었거나 새로 만든 깃허브 프로젝트를 도큐사우르스 사이트 경로로 사용하곤 합니다. 하지만 무조건 그래야 하는 것은 아닙니다.

  3. npx docusaurus-init을 입력해 도큐사우르스 설치 스크립트를 실행합니다.

    사용하는 Node 버전이 8.2 미만인 경우에는 도큐사우르스를 글로벌로 설치하는 것이 좋습니다. yarn global add docusaurus-init 또는 npm install --global docusaurus-init 명령어를 먼저 실행합니다. 그리고 나서 docusaurus-init 명령어를 사용해 도큐사우르스 설치 스크립트를 실행합니다.

Verifying Installation

Along with previously existing files and directories, your root directory will now contain a structure similar to:

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

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 포트가 이미 사용중이라면, 다른 포트가 사용될 것입니다. 콘솔 메시지를 통해 사용되는 포트를 확인 할 수 있습니다.

    You should see the example site loaded in your web browser. There's also a LiveReload server running and any changes made to the docs and files in the website directory will cause the page to refresh. 웹사이트 테마에 사용되는 주색상과 보조색상은 랜덤으로 생성됩니다.

프록시 설정을 무시하고 서버 실행하기

If you are behind a corporate proxy, you need to disable it for the development server requests. It can be done using the NO_PROXY environment variable.

SET NO_PROXY=localhost
yarn start (또는 npm run start)

Updating Your Docusaurus Version

도큐사우르스를 설치한 후에 website 디렉토리 위치에서 yarn outdated docusaurus 또는 npm outdated docusaurus 명령어를 실행하면 최신 버전의 도큐사우르스를 확인할 수 있습니다.

You will see something like this:

$ 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 명령어를 실행했을때 설치할 버전 안내가 없다면 최신 버전이 설치된 상태입니다.

You can update to the latest version of Docusaurus by:

yarn upgrade docusaurus --latest

또는

npm update docusaurus

업그레이드 후에 에러가 발생한다면 바벨 캐시(일반적으로 temporary directory에 쌓여있습니다)를 삭제해보거나 도큐사우르스 서버(yarn start 명령어로 실행하는) 설정 중에서 BABEL_DISABLE_CACHE=1 값을 변경해봅니다.

Site Preparation →