배포
웹 사이트에 게시할 파일을 빌드하기 위해서 아래 명령을 실행합니다.
- npm
- Yarn
- pnpm
npm run build
yarn build
pnpm run build
명령을 실행하면 build
디렉터리 아래에 파일이 생성됩니다.
도큐사우루스는 여러분의 사이트를 빌드하고 정적 파일을 build
디렉터리 아래에 생성하는 것까지만 책임집니다.
만들어진 정적 파일을 어떻게 호스팅할 것인지는 여러분에게 달려 있습니다.
You can deploy your site to static site hosting services such as Vercel, GitHub Pages, Netlify, Render, and Surge.
도큐사우루스 사이트는 정적 렌더링 방식을 사용합니다. 자바스크립트가 없이도 잘 동작합니다.
설정
라우팅을 최적화하고 올바른 위치에서 파일을 제공하려면 docusaurus.config.js
에 다음 매개변수가 필요합니다.
옵션명 | 설명 |
---|---|
url | 사이트의 URL을 설정합니다. 사이트 배포 경로가 https://my-org.com/my-project/ 이라면 url 은 https://my-org.com/ 입니다. |
baseUrl | 트레일링 슬래시를 포함한 프로젝트 Base URL을 설정합니다. 사이트 배포 경로가 https://my-org.com/my-project/ 이라면 baseUrl 은 /my-project/ 입니다. |
로컬에서 빌드 테스트하기
실제 배포 작업을 진행하기 전에 로컬에서 빌드 테스트를 진행해야 합니다. 도큐사우루스는 로컬 빌드 테스트를 위한 docusaurus serve
명령을 지원합니다:
- npm
- Yarn
- pnpm
npm run serve
yarn serve
pnpm run serve
By default, this will load your site at http://localhost:3000/
.
트레일링 슬래시 설정
Docusaurus has a trailingSlash
config to allow customizing URLs/links and emitted filename patterns.
기본값에서도 잘 동작합니다. 하지만 정적 호스팅 서비스 제공 업체에 따라 다른 동작 방식을 가질 수 있습니다. 때문에 같은 사이트를 여러 서비스에 배포하면 다른 결과가 나타날 수도 있습니다. 여러분이 선택한 호스팅 서비스에 따라 설정을 변경해서 사용할 수 있습니다.
호스팅 서비스에서 지원하는 동작 방식과 적절한 trailingSlash
설정을 위해 slorber/trailing-slash-guide 문서를 참조하세요.
환경 변수 사용하기
잠재적으로 민감할 수 있는 정보는 환경 설정으로 빼놓은 것이 일반적인 관행입니다. However, in a typical Docusaurus website, the docusaurus.config.js
file is the only interface to the Node.js environment (see our architecture overview), while everything else (MDX pages, React components, etc.) are client side and do not have direct access to the process
global variable. 이런 경우에는 customFields
를 사용해 환경 변수를 클라이언트 쪽으로 전달하는 것을 고려해볼 수 있습니다.
// If you are using dotenv (https://www.npmjs.com/package/dotenv)
import 'dotenv/config';
export default {
title: '...',
url: process.env.URL, // You can use environment variables to control site specifics as well
customFields: {
// Put your custom environment here
teamEmail: process.env.EMAIL,
},
};
import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
export default function Home() {
const {
siteConfig: {customFields},
} = useDocusaurusContext();
return <div>Contact us through {customFields.teamEmail}!</div>;
}
호스팅 공급자 선택하기
몇 가지 공통적인 호스팅 옵션입니다.
- Self hosting with an HTTP server like Apache2 or Nginx.
- Jamstack providers (e.g. Netlify and Vercel). 이들을 참조하긴 하지만 다른 공급자들도 같은 방식을 적용될 수 있습니다.
- GitHub Pages (by definition, it is also Jamstack, but we compare it separately).
어떤 것을 선택해야 할지 잘 모르겠다면 다음 질문을 참고하세요.
How many resources (money, person-hours, etc.) am I willing to invest in this?
- 🔴 Self-hosting requires experience in networking as well as Linux and web server administration. It's the most difficult option, and would require the most time to manage successfully. Expense-wise, cloud services are almost never free, and purchasing/deploying an onsite server can be even more costly.
- 🟢 Jamstack providers can help you set up a working website in almost no time and offer features like server-side redirects that are easily configurable. Many providers offer generous build-time quotas even for free plans that you would almost never exceed. However, free plans have limits, and you would need to pay once you hit those limits. 자세한 내용은 공급자의 가격 목록을 확인하세요.
- 🟡 깃헙 페이지 배포 흐름은 설정하기가 지겨울 수 있습니다. (깃헙 페이지 배포하기 설명이 얼마나 긴지 확인해보면 알 수 있다!) 하지만 이 서비스(빌드와 배포를 포함해)는 공개 저장소인 경우 항상 무료이며 작업에 필요한 자세한 지침을 제공해줍니다.
How much server-side customization do I need?
- 🟢 자체 호스팅을 사용하면 전체 서버 구성에 접근할 수 있습니다. You can configure the virtual host to serve different content based on the request URL, you can do complicated server-side redirects, you can implement authentication, and so on. 서버 측 기능이 많이 필요한 경우 웹사이트 자체 호스팅을 추천합니다.
- 🟡 Jamstack usually offers some server-side configuration (e.g. URL formatting (trailing slashes), server-side redirects, etc.).
- 🔴 GitHub Pages doesn't expose server-side configuration besides enforcing HTTPS and setting CNAME records.
Do I need collaboration-friendly deployment workflows?
- 🟡 Self-hosted services can leverage continuous deployment functionality like Netlify, but more heavy-lifting is involved. Usually, you would designate a specific person to manage the deployment, and the workflow wouldn't be very git-based as opposed to the other two options.
- 🟢 Netlify와 Vercel은 모두 풀 리퀘스트에 대한 배포 미리보기를 지원해서 팀이 제품을 병합하기 전에 작업을 검토하는데 유용합니다. 배포에 접근할 수 있는 다른 구성원을 팀으로 관리할 수 있습니다.
- 🟡 깃헙 페이지는 배포 미리보기를 쉽게 설정할 수 있도록 허용하지 않습니다. 하나의 저장소는 하나의 사이트 배포에만 연결할 수 있습니다. 하지만 사이트 배포에 대한 쓰기 접근 권한을 가진 사용자를 관리할 수 있습니다.
모든 것을 만족하는 해결책은 없습니다. 선택을 하기 전에 어떤 것이 필요한지 어떤 자원을 가지고 있는지 확인하고 결정해야 합니다.
웹 서버를 구축하고 직접 호스팅하기
도큐사우루스에서 docusaurus serve
명령을 사용해 직접 호스팅할 준비를 할 수 있습니다. --port
옵션에서 포트를 변경하고 --host
옵션에서 호스트를 변경합니다.
- npm
- Yarn
- pnpm
npm run serve -- --build --port 80 --host 0.0.0.0
yarn serve --build --port 80 --host 0.0.0.0
pnpm run serve --build --port 80 --host 0.0.0.0
직접 호스팅하는 것은 정적 호스팅 서비스 제공 업체나 CDN과 비교해서 최선의 선택은 아닙니다.
다음 섹션에서는 몇 가지 대중적인 호스팅 공급자에서 도큐사우루스 사이트를 가장 효율적으로 배포하기 위한 구성 방법을 소개합니다. Docusaurus is not affiliated with any of these services, and this information is provided for convenience only. Some of the write-ups are provided by third-parties, and recent API changes may not be reflected on our side. If you see outdated content, PRs are welcome.
Because we can only provide this content on a best-effort basis only, we have stopped accepting PRs adding new hosting options. 하지만 별도 사이트(예를 들어 블로그 또는 호스팅 공급자 웹사이트)에 글을 게시하고 해당 콘텐츠에 대한 링크를 포함하도록 요청할 수는 있습니다.
네트리파이(Netlify)를 사용해 배포하기
To deploy your Docusaurus sites to Netlify, first make sure the following options are properly configured:
export default {
url: 'https://docusaurus-2.netlify.app', // Url to your site with no trailing slash
baseUrl: '/', // Base directory of your site relative to your repo
// ...
};
그리고나서 여러분의 사이트를 네트리파이에 만듭니다.
사이트 설정을 위해 다음과 같은 빌드 명령과 디렉터리를 지정해주세요.
- 빌드 명령:
npm run build
- 배포 디렉터리:
build
사전에 빌드 옵션을 설정하지 않았더라도 사이트를 만든 이후에 "Site settings" -> "Build & deploy" 메뉴에서 설정할 수 있습니다.
위에 설명한 옵션으로 적절하게 설정했다면 여러분의 사이트를 배포할 수 있습니다. 그리고 기본적으로 main
으로 설정된 배포 브랜치에 병합되면 자동으로 재배포가 진행됩니다.
일부 도큐사우루스 사이트는 아래와 같이 website
폴더 바깥쪽에 docs
폴더를 가집니다(대부분 도큐사우루스 v1 사이트입니다)
repo # git root
├── docs # MD files
└── website # Docusaurus root
website
폴더를 네트리파이 기본 디렉터리로 사용하는 것으로 설정하면 네트리파이는 docs
폴더를 업데이트할 때 빌드 작업을 실행하지 않습니다. 그리고 아래와 같이 사용자 지정 ignore
명령을 설정해주어야 합니다.
[build]
ignore = "git diff --quiet $CACHED_COMMIT_REF $COMMIT_REF . ../docs/"
기본적으로 네트리파이는 트레일링 슬래시를 도큐사우루스 URL에 추가합니다.
It is recommended to disable the Netlify setting Post Processing > Asset Optimization > Pretty Urls
to prevent lowercase URLs, unnecessary redirects, and 404 errors.
정말 주의하세요: Disable asset optimization
전역 체크 기능은 잘 동작하지 않습니다. 해당 항목을 체크해도 Pretty URLs
설정이 비활성화되지는 않습니다. 각 항목을 개별적으로 체크해주세요.
네트리파이에서 Pretty Urls
설정을 활성화하고 싶다면 도큐사우루스에서 trailingSlash
설정을 그에 맞게 조정해주어야 합니다.
좀 더 자세한 정보는 slorber/trailing-slash-guide를 참고하세요.
베르셀(Vercel)을 사용해 배포하기
도큐사우루스 프로젝트를 베르셀(Vercel)에 배포하면 성능과 사용 편의성 측면에서 몇 가지 이점이 제공됩니다.
베르셀 깃 통합 기능을 사용해 도큐사우루스 프로젝트를 배포하기 위해서는 깃 저장소에 제대로 업로드되었는지 확인합니다.
베르셀의 가져오기 기능을 이용해 프로젝트를 가져옵니다. During the import, you will find all relevant options preconfigured for you; however, you can choose to change any of these options.
프로젝트를 가져온 후 브랜치로 보내지는 모든 작업에 대해 미리보기 배포가 만들어집니다. 그리고 제품 브랜치(보통 "main" 또는 "master")에 변경이 생기면 제품 배포가 진행됩니다.
깃허브 페이지(GitHub Pages)를 사용해 배포하기
Docusaurus provides an easy way to publish to GitHub Pages, which comes free with every GitHub repository.
개요
Usually, there are two repositories (at least two branches) involved in a publishing process: the branch containing the source files, and the branch containing the build output to be served with GitHub Pages. 이 글에서는 각각 소스와 배포라고 하겠습니다.
각각의 깃허브 저장소는 깃허브 페이지 서비스와 연결됩니다. 배포 저장소가 my-org/my-project
(여기서 my-org
는 조직 또는 사용자 이름입니다)인 경우 배포된 사이트는 https://my-org.github.io/my-project/
가 됩니다. If the deployment repository is called my-org/my-org.github.io
(the organization GitHub Pages repo), the site will appear at https://my-org.github.io/
.
깃허브 페이지에 여러분이 가지고 있는 도메인을 연결하기 원한다면 static
디렉터리 안에 CNAME
파일을 만들어줍니다. static
디렉터리 아래 있는 파일은 모두 배포 시 build
디렉터리 아래로 복사됩니다. 사용자 정의 도메인을 사용한다면 baseUrl: '/projectName/'
에서 baseUrl: '/'
로 돌아갈 수 있어야 하며 url
을 여러분의 사용자 정의 도메인으로 설정해야 합니다.
좀 더 자세한 내용은 깃허브 페이지 가이드 문서를 참고하세요.
깃허브 페이지는 기본 브랜치(일반적으로 master
/ main
) 또는 gh-pages
브랜치 그리고 루트 폴더 또는 /docs
폴더에서 배포 대상 파일(docusaurus build
에서 만든)을 가져옵니다. 저장소 Settings > Pages
에서 필요한 항목을 설정할 수 있습니다. 이 브랜치를 "배포 브랜치"라고 합니 다.
하나의 명령으로 소스 브랜치에서 배포 브랜치로 사이트를 배포할 수 있게 docusaurus deploy
명령인 clone, build, commit을 제공합니다.
docusaurus.config.js
파일 설정하기
먼저 docusaurus.config.js
파일에서 필요한 몇 가지 항목을 추가해주어야 합니다.
옵션명 | 설명 |
---|---|
organizationName | 배포 저장소를 소유하고 있는 깃허브 사용자 또는 그룹 계정을 설정합니다. |
projectName | 배포 저장소 이름을 설정합니다. |
deploymentBranch | The name of the deployment branch. It defaults to 'gh-pages' for non-organization GitHub Pages repos (projectName not ending in .github.io ). Otherwise, it needs to be explicit as a config field or environment variable. |
These fields also have their environment variable counterparts which have a higher priority: ORGANIZATION_NAME
, PROJECT_NAME
, and DEPLOYMENT_BRANCH
.
깃헙 페이지는 도큐사우루스 URL에 트레일링 슬래시를 기본적으로 추가합니다. trailingSlash
설정은 (true
또는 false
, undefined
는 제외) 값으로 설정하는 것을 권장합니다.
예:
export default {
// ...
url: 'https://endiliey.github.io', // Your website URL
baseUrl: '/',
projectName: 'endiliey.github.io',
organizationName: 'endiliey',
trailingSlash: false,
// ...
};
기본적으로 깃허브 페이지는 지킬을 통해 게시된 파일을 실행합니다. 지킬은 _
로 시작하는 모든 파일을 삭제합니다. 때문에 static
디렉터리에 .nojekyll
라는 이름을 가진 빈 파일을 추가해 지킬을 비활성화하는 것을 권장합니다.
환경 설정
옵션명 | 설명 |
---|---|
USE_SSH | 깃허브 저장소에 연결 시 기본 HTTPS 대신 SSH를 사용하려면 true 로 설정합니다. 소스 저장소 URL이 SSH URL(예 [email protected]:facebook/docusaurus.git )인 경우 USE_SSH 값이 true 로 추측할 수 있습니다. |
GIT_USER | 배포 저장소에 push 권한을 가지고 있는 깃허브 계정 사용자 이름입니다. 여러분이 소유자인 저장소라면 사용하고 있는 깃허브 사용자명을 설정합니다. SSH를 사용하지 않는다면 필수이며 그렇지 않은 경우에는 무시됩니다. |
GIT_PASS | 비대화형 배포(예 지속적인 배포)를 용이하게 하기 위한 깃허브 사용자(특히 GIT_USER )의 개인 액세스 토큰 |
CURRENT_BRANCH | 소스 브랜치. 일반적으로 브랜치는 main 또는 master 입니다. 하지만 gh-pages 을 제외한 어떤 브랜치든지 가능합니다. 이 변수를 설정하지 않으면 docusaurus deploy 가 호출되는 현재 브랜치가 사용됩니다. |
GIT_USER_NAME | The git config user.name value to use when pushing to the deployment repo |
GIT_USER_EMAIL | The git config user.email value to use when pushing to the deployment repo |
깃허브 엔터프라이즈를 사용하는 경우에도 깃허브와 다르지 않습니다. 환경 변수에 깃허브 엔터프라이즈에서 사용하는 그룹 계정을 설정해주기만 하면 됩니다.
옵션명 | 설명 |
---|---|
GITHUB_HOST | 깃허브 엔터프라이즈 사이트에서 사용하는 도메인 이름을 설정합니다. |
GITHUB_PORT | 깃허브 엔터프라이즈 사이트에서 사용하는 포트를 설정합니다. |
배포
이제 아래 명령을 사용해 여러분의 사이트를 깃허브 페이지로 배포합니다.
- Bash
- Windows
- PowerShell
GIT_USER=<GITHUB_USERNAME> yarn deploy
cmd /C "set "GIT_USER=<GITHUB_USERNAME>" && yarn deploy"
cmd /C 'set "GIT_USER=<GITHUB_USERNAME>" && yarn deploy'
2021년 8월부터 깃허브에서는 암호 대신 개인 액세스 토큰을 사용하기 위해 모두에게 명령줄 로그인을 요구합니다. 깃허브에서 암호를 묻는 메시지가 표시되면 PAT를 대신 입력하세요. 좀 더 자세한 내용은 깃허브 문서를 참고하세요.
그렇지 않으면 SSH (USE_SSH=true
)를 사용해 로그인할 수 있습니다.
깃허브 액션(GitHub Actions)을 사용해 자동으로 배포하기
깃허브 액션은 여러분의 저장소에서 소프트웨어 배포를 자동으로 원하는 형태로 실행할 수 있도록 지원합니다.
The workflow examples below assume your website source resides in the main
branch of your repository (the source branch is main
), and your publishing source is configured for publishing with a custom GitHub Actions Workflow.
우리의 목표는 다음과 같습니다.
main
에 대한 새로운 풀 리퀘스트가 올라오면 실제 배포는 진행하지 않고 빌드만 성공하게 합니다. 작업 이름은test-deploy
라고 붙입니다.- When a pull request is merged to the
main
branch or someone pushes to themain
branch directly, it will be built and deployed to GitHub Pages. 작업 이름은deploy
라고 붙입니다.
다음은 깃허브 액션을 사용해 문서를 배포하는 두 가지 접근 방식입니다. Based on the location of your deployment repository, choose the relevant tab below:
- 소스 저장소와 배포 저장소는 같은 저장소입니다.
- 배포 저장소는 소스 저장소와 다른 원격 저장소입니다. Instructions for this scenario assume publishing source is the
gh-pages
branch.
- Same
- Remote
While you can have both jobs defined in the same workflow file, the original deploy
workflow will always be listed as skipped in the PR check suite status, which is not indicative of the actual status and provides no value to the review process. 따라서 대신 별도의 워크플로로 관리할 것을 제안합니다.
깃허브 액션 파일
다음 두 개의 워크플로 파일을 추가합니다.
이 파일 설정은 Yarn을 사용하고 있다고 전제합니다. npm을 사용하는 경우에는 cache: yarn
, yarn install --frozen-lockfile
, yarn build
을 cache: npm
, npm ci
, npm run build
로 적절하게 변 경합니다.
도큐사우루스 프로젝트가 저장소 루트에 없다면 기본 작업 디렉터리를 구성해야 할 수도 있습니다. 그에 따라 경로를 조정하세요.
name: Deploy to GitHub Pages
on:
push:
branches:
- main
# Review gh actions docs if you want to further define triggers, paths, etc
# https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on
jobs:
build:
name: Build Docusaurus
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
- uses: actions/setup-node@v4
with:
node-version: 18
cache: yarn
- name: Install dependencies
run: yarn install --frozen-lockfile
- name: Build website
run: yarn build
- name: Upload Build Artifact
uses: actions/upload-pages-artifact@v3
with:
path: build
deploy:
name: Deploy to GitHub Pages
needs: build
# Grant GITHUB_TOKEN the permissions required to make a Pages deployment
permissions:
pages: write # to deploy to Pages
id-token: write # to verify the deployment originates from an appropriate source
# Deploy to the github-pages environment
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
name: Test deployment
on:
pull_request:
branches:
- main
# Review gh actions docs if you want to further define triggers, paths, etc
# https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on
jobs:
test-deploy:
name: Test deployment
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
- uses: actions/setup-node@v4
with:
node-version: 18
cache: yarn
- name: Install dependencies
run: yarn install --frozen-lockfile
- name: Test build website
run: yarn build
A cross-repo publish is more difficult to set up because you need to push to another repo with permission checks. 예제에서는 SSH 인증을 사용합니다.
- 새로운 SSH 키를 만듭니다. SSH 키는 CI에서 사용되므로 암호를 입력하지 마세요.
- 기본적으로 여러분의 공개키는
~/.ssh/id_rsa.pub
에 만들어지거나 이전 단계에서 깃허브 배포 키로 추가한 키 이름을 사용할 수 있습니다. pbcopy < ~/.ssh/id_rsa.pub
명령으로 키를 클립보드에 복사하고 배포 저장소에 배포키로 붙여넣습니다. 명령행 도구를 사용하기 곤란하다면 파일 콘텐츠를 복사할 수 있습니다. 배포키를 저장하기 전에Allow write access
박스에 체크해주어야 합니다.- 도큐사우루스에서 배포를 자동으로 처리할 수 있도록 허용하려면 깃허브 보안 설정에서 개인키를 설정해주어야 합니다.
pbcopy < ~/.ssh/id_rsa
명령을 사용해 개인키를 복사하고 깃허브 보안 설정에서GH_PAGES_DEPLOY
항목에 붙여넣습니다. 명령행 도구를 사용하기 곤란하다면 파일 콘텐츠를 복사할 수 있습니다. 보안 설정을 저장합니다..github/workflows/
경로에 문서를 위한 워크플로우 파일을 만듭니다. In this example, it'sdeploy.yml
.
At this point, you should have:
- the source repo with the GitHub workflow set with the private SSH key as the GitHub Secret, and
- your deployment repo set with the public SSH key in GitHub Deploy Keys.
깃허브 액션 파일
Please make sure that you replace [email protected]
with your GitHub email and gh-actions
with your name.
This file assumes you are using Yarn. npm을 사용하는 경우에는 cache: yarn
, yarn install --frozen-lockfile
, yarn build
을 cache: npm
, npm ci
, npm run build
로 적절하게 변경합니다.
name: Deploy to GitHub Pages
on:
pull_request:
branches: [main]
push:
branches: [main]
permissions:
contents: write
jobs:
test-deploy:
if: github.event_name != 'push'
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
- uses: actions/setup-node@v4
with:
node-version: 18
cache: yarn
- name: Install dependencies
run: yarn install --frozen-lockfile
- name: Test build website
run: yarn build
deploy:
if: github.event_name != 'pull_request'
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
- uses: actions/setup-node@v4
with:
node-version: 18
cache: yarn
- uses: webfactory/ssh-[email protected]
with:
ssh-private-key: ${{ secrets.GH_PAGES_DEPLOY }}
- name: Deploy to GitHub Pages
env:
USE_SSH: true
run: |
git config --global user.email "[email protected]"
git config --global user.name "gh-actions"
yarn install --frozen-lockfile
yarn deploy
사이트가 제대로 배포되지 않았나요?
After pushing to main, if you don't see your site published at the desired location (for example, it says "There isn't a GitHub Pages site here", or it's showing your repo's README.md file), try the following:
- Wait about three minutes and refresh. It may take a few minutes for GitHub pages to pick up the new files.
- Check your repo's landing page for a little green tick next to the last commit's title, indicating the CI has passed. If you see a cross, it means the build or deployment failed, and you should check the log for more debugging information.
- Click on the tick and make sure you see a "Deploy to GitHub Pages" workflow. Names like "pages build and deployment / deploy" are GitHub's default workflows, indicating your custom deployment workflow failed to be triggered at all. Make sure the YAML files are placed under the
.github/workflows
folder, and that the trigger condition is set correctly (e.g., if your default branch is "master" instead of "main", you need to change theon.push
property). - Under your repo's Settings > Pages, make sure the "Source" (which is the source for the deployment files, not "source" as in our terminology) is set to "gh-pages" + "/ (root)", since we are using
gh-pages
as the deployment branch.
If you are using a custom domain:
- Verify that you have the correct DNS records set up if you're using a custom domain. See GitHub pages documentation on configuring custom domains. Also, please be aware that it may take up to 24 hours for DNS changes to propagate through the internet.