CLI Commands
Docusaurus는 웹사이트를 만들거나, 관련 서비스를 제공하거나 배포할 수 있도록 도와주는 스크립트 세트를 제공합니다. Yarn이나 npm을 사용하여 run 명령어로 호출할 수 있습니다. 그 예는 다음과 같습니다:
yarn run start: 웹브라우져에서 작업중인 프로젝트 앱을 실시간 보여 줍니다.yarn run examples: 예제 설정 파일들을 생성합니다
CLI에서 실행하기
Yarn 이나 npm을 사용해서 이 스크립트들을 실행할 수 있습니다. 시작 가이드를 읽어 보신분이라면 start 명령어를 보셨을 것입니다. 아래의 명령어를 실행하면 Docusarurus는 프로젝트 사이트에 필요한 파일들을 생성한 후, 프리뷰 서버를 실행하게 됩니다. 아래의 명령어를 커맨드라인에서 실행하면 Docusarurus는 프로젝트 사이트에 필요한 파일들을 생성한 후, 프리뷰 서버를 실행하게 됩니다.
yarn run start
아래와 같이 npm을 이용해도 됩니다:
npm run start
같은 방식으로, start 명령어에 다른 명령어를 대입하는 식으로 원하시는 스크립트를 실행 할 수 있습니다.
옵션 명령어 추가하기
명령어에 옵션을 추가할 수 있습니다. 예를 들어 서버를 8080 포트에서 동작하려면 당신은 start를 실행하면서 --port를 입력할 수 있습니다:
yarn run start --port 8080
Npm을 사용하는 경우, npm run <command>다음에 -- 을 사용하고 아래와 같이 옵션을 추가 할 수 있습니다.
npm run start -- --port 8080
환경설정
이 스크립트들은 설치 과정에서 website/package.json파일 안에 있는 "scripts" 키 하위에 설정됩니다. 이를 변경하고자 재설치를 원하시면 먼저, 설치 가이드를 참고하시면 도움이 될 것입니다.
Docusaurus는 Node 어법을 사용하는 명령어 실행을 할 수 있도록 하고 있고 이에 대한 명령어 조합을 기본으로 제공 하고 있습니다. 매번 docusaurus-start를 입력하는 대신, yarn run start 또는 npm start을 사용해도 똑같은 결과를 얻을 수 있습니다.
명령어
docusaurus-buildducusaurus-예제docusaurus-publishdocusaurus-rename-versiondocusaurus-startdocusaurus-version <version>docusaurus-write-translations
참고
docusaurus-build
Alias: build.
| 옵션 | 기본설정 | 설명 |
|---|---|---|
--skip-image-compression | false | 이미지 파일 압축 안함. 이미지 파일을 최적화 하지 않았다면 기본설정을 바꾸지 마시기 바랍니다. |
--skip-next-release | false | 기본설정데로라면 버젼 옵션을 선택한 경우라도 새로운 버젼이 생성되지 않습니다. 기본 설정의 의미는 /docs폴더 파일의 HTML 변환을 하지 않게 됩니다. |
필요에따라 번역을 적용한 정적 사이트를 생성합니다. 배포전에 웹사이트를 구성하는데 유용 함.
docusaurus-start를 참고하세요.
ducusaurus-예제
Alias: 예제
| 옵션 | 기본설정 | 설명 |
|---|---|---|
<feature> | - | translations나 versions중 하나를 명시해서 해당하는 별도의 파일들이 생성되도록 합니다. |
예시
docusaurus-examples <feature>
feature 옵션을 지정하지 않으면, 최소기능만 설정된 예제 사이트가 생성됩니다. 이 명령에 대한 자세한 내용은 사이트 준비 가이드를 참고하세요.
docusaurus-publish
Alias: publish-gh-pages
Builds를 하고 나면 정적 웹사이트를 GitHub Pages에 배포합니다. 이 명령은 CircleCI의 배포단계에서 실행되기 때문에, 몇가지 환경 변수가 정의되어 있어야 합니다:
다음의 환경변수들은 일반적으로 사용자가 CircleCI config.yml파일에 직접 설정합니다.
GIT_USER: 배포 commit과 관련된 git 사용자명USE_SSH: Whether to use SSH instead of HTTPS for your connection to the GitHub repo.
예시
GIT_USER=docusaurus-bot USE_SSH=true yarn run publish-gh-pages
The following environment variables are set by CircleCI during the build process.
CIRCLE_BRANCH: commit이 되면 CI 실행이 트리거되는 git branch명CI_PULL_REQUEST: Expected to be truthy if the current CI run was triggered by a commit in a pull request.
The following should be set by you in siteConfig.js as organizationName and projectName, respectively. If they are not set in your site configuration, they fall back to the CircleCI environment.
CIRCLE_PROJECT_USERNAME: The GitHub username or organization name that hosts the Git repo, e.g. "facebook".CIRCLE_PROJECT_REPONAME: The name of the Git repo, e.g. "Docusaurus".
You can learn more about configuring automatic deployments with CircleCI in the Publishing guide.
docusaurus-rename-version
Alias: rename-version
Renames an existing version of the docs to a new version name.
| 옵션 | 기본설정 | 설명 |
|---|---|---|
<currentVersion> | - | 현재 버전 |
<newVersion> | - | 새로운 버전 |
예시
docusaurus-rename-version <currentVersion> <newVersion>
See the Versioning guide to learn more.
docusaurus-start
Alias: start.
This command will build the static website, apply translations if necessary, and then start a local server.
| 옵션 | 기본설정 | 설명 |
|---|---|---|
--port <number> | 3000 | 웹사이트의 기본포트는 3000입니다. 포트 3000이 이미 사용중인 경우에는 Docusaurus가 이용 가능한 다른 포트를 찾을 것입니다. |
--watch | - | Whether to watch the files and live reload the page when files are changed. Defaults to true. Disable this by using --no-watch. |
You can specify the browser application to be opened by setting the BROWSER environment variable before the command, e.g.:
$ BROWSER=firefox yarn start
docusaurus-version <version>
Alias: version
Generates a new version of the docs. This will result in a new copy of your site being generated and stored in its own versioned directory. Useful for capturing snapshots of API docs that map to specific versions of your software. Accepts any string as a version number.
See the Versioning guide to learn more.
docusaurus-write-translations
Alias: write-translations
Writes the English for any strings that need to be translated into an website/i18n/en.json file. The script will go through every file in website/pages/en and through the siteConfig.js file and other config files to fetch English strings that will then be translated on Crowdin. See the Translation guide to learn more.