CLI(명령 줄 인터페이스)
도큐사우루스는 여러분의 웹 사이트를 만들고 확인하고 배포할 수 있게 도움을 주는 스크립트 모음을 제공합니다.
웹 사이트를 만들면 소스 안에 패키지 관리자를 호출할 수 있는 도큐사우루스 스크립트가 포함되어 있습니다.
package.json
{
// ...
"scripts": {
"docusaurus": "docusaurus",
"start": "docusaurus start",
"build": "docusaurus build",
"swizzle": "docusaurus swizzle",
"deploy": "docusaurus deploy",
"clear": "docusaurus clear",
"serve": "docusaurus serve",
"write-translations": "docusaurus write-translations",
"write-heading-ids": "docusaurus write-heading-ids"
}
}
도큐사우루스 CLI 명령
도큐사우루스 CLI 명령과 사용법을 설명합니다.
docusaurus start [siteDir]
웹팩 개발 서버를 사용해 여러분의 사이트를 로컬에서 빌드하고 미리보기를 제공합니다.
옵션
옵션명 | 기본값 | 설명 |
---|---|---|
--dev | Builds in dev mode, including full React error messages. | |
--port | 3000 | 개발 서버에서 사용할 포트를 설정합니다. |
--host | localhost | 사용할 호스트를 설정합니다. 외부에서 접근할 수 있게 --host 0.0.0.0 형태로 설정할 수도 있습니다. |
--hot-only | false | 빌드 실패 시 폴백 처리로 페이지 새로고침 없이 빠른 모듈 교체(Hot Module Replacement)를 사용할지 여부를 설정합니다. 좀 더 많은 정보는 웹팩 문서를 참고하세요. |
--no-open | false | Do not open the page automatically in the browser. |
--config | undefined | 도큐사우루스 설정 파일 경로를 설정합니다. 기본값은 [siteDir]/docusaurus.config.js 입니다. |
--poll [optionalIntervalMs] | false | 변경 상태 체크가 제대로 되지 않을 때 폴백 처리로 라이브 리로드 대신 파일 폴링을 사용하도록 설정할 수 있습니다. 좀 더 많은 정보는 웹팩 문서를 참고하세요. |
--no-minify | false | JS/CSS 번들 최소화 없이 웹 사이트를 빌드할지 여부를 설정합니다. |
정보
일부 기능(앵커 링크 같은)은 개발 모드에서는 잘 동작하지 않을 수 있습니다. 하지만 제품 모드에서는 정상적으로 동작합니다.
네크워크를 통한 개발
원격 서버 또는 VM(예: 깃헙 코드스페이스)에서 3000번 포트를 포워딩하면 로컬 IP에서 수신할 수 있게 해서 0.0.0.0
에서 개발 서버를 실행할 수 있습니다.
- npm
- Yarn
- pnpm
npm run start -- --host 0.0.0.0
yarn run start --host 0.0.0.0
pnpm run start -- --host 0.0.0.0
HTTPS를 사용하도록 설정하기
인증서를 받는 방법은 여러 가지가 있습니다. 여기서는 설명을 위해 mkcert를 사용할 겁니다.
-
localhost.pem
+localhost-key.pem
파일을 만들기 위해mkcert localhost
명령을 실행합니다. -
로컬에 인증서를 설치하기 위해
mkcert -install
명령을 실행합니다. 그리고 웹 브라우저를 다시 시작합니다. -
HTTPS 환경 변수를 설정하고 도 큐사우루스 앱을 실행합니다.
HTTPS=true SSL_CRT_FILE=localhost.pem SSL_KEY_FILE=localhost-key.pem yarn start
- 웹 브라우저에서
https://localhost:3000/
을 실행합니다.