배포
웹 사이트에 게시할 파일을 빌드하기 위해서 아래 명령을 실행합니다.
- npm
- Yarn
- pnpm
npm run build
yarn build
pnpm run build
Once it finishes, the static files will be generated within the build
directory.
The only responsibility of Docusaurus is to build your site and emit static files in build
.
만들어진 정적 파일을 어떻게 호스팅할 것인지는 여러분에게 달려 있습니다.
You can deploy your site to static site hosting services such as Vercel, GitHub Pages, Netlify, Render, and Surge.
도큐사우루스 사이트는 정적 렌더링 방식을 사용 합니다. 자바스크립트가 없이도 잘 동작합니다.
Configuration
The following parameters are required in docusaurus.config.js
to optimize routing and serve files from the correct location:
옵션명 | 설명 |
---|---|
url | 사이트의 URL을 설정합니다. For a site deployed at https://my-org.com/my-project/ , url is https://my-org.com/ . |
baseUrl | 트레일링 슬래시를 포함한 프로젝트 Base URL을 설정합니다. For a site deployed at https://my-org.com/my-project/ , baseUrl is /my-project/ . |
Testing your Build Locally
실제 배포 작업을 진행하기 전에 로컬에서 빌드 테스트를 진행해야 합니다. Docusaurus provides a docusaurus serve
command for that:
- npm
- Yarn
- pnpm
npm run serve
yarn serve
pnpm run serve
By default, this will load your site at http://localhost:3000/
.
Trailing slash configuration
Docusaurus has a trailingSlash
config to allow customizing URLs/links and emitted filename patterns.
기본값에서도 잘 동작합니다. Unfortunately, each static hosting provider has a different behavior, and deploying the exact same site to various hosts can lead to distinct results. 여러분이 선택한 호스팅 서비스에 따라 설정을 변경해서 사용할 수 있습니다.
Use slorber/trailing-slash-guide to understand better the behavior of your host and configure trailingSlash
appropriately.
Using environment variables
잠재적으로 민감할 수 있는 정보는 환경 설정으로 빼놓은 것이 일반적인 관행입니다. 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. In this case, you can consider using customFields
to pass environment variables to the client side.
// 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>;
}
Choosing a hosting provider
몇 가지 공통적인 호스팅 옵션입니다.
- 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. 자세한 내용은 공급자의 가격 목록을 확인하세요.
- 🟡 깃헙 페이지 배포 흐름은 설정하기가 지겨울 수 있습니다. (Evidence: see the length of Deploying to GitHub Pages!) 하지만 이 서비스(빌드와 배포를 포함해)는 공개 저장소인 경우 항상 무료이며 작업에 필요한 자세한 지침을 제공해줍니다.
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은 모두 풀 리퀘스트에 대한 배포 미리보기를 지원해서 팀이 제품을 병합하기 전에 작업을 검토하는데 유용합니다. 배포에 접근할 수 있는 다른 구성원을 팀으로 관리할 수 있습니다.
- 🟡 깃헙 페이지는 배포 미리보기를 쉽게 설정할 수 있도록 허용하지 않습니다. 하나의 저장소는 하나의 사이트 배포에만 연 결할 수 있습니다. 하지만 사이트 배포에 대한 쓰기 접근 권한을 가진 사용자를 관리할 수 있습니다.
모든 것을 만족하는 해결책은 없습니다. 선택을 하기 전에 어떤 것이 필요한지 어떤 자원을 가지고 있는지 확인하고 결정해야 합니다.
Self-Hosting
Docusaurus can be self-hosted using docusaurus serve
. Change port using --port
and --host
to change 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. 하지만 별도 사이트(예를 들어 블로그 또는 호스팅 공급자 웹사이트)에 글을 게시하고 해당 콘텐츠에 대한 링 크를 포함하도록 요청할 수는 있습니다.
Deploying to 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
// ...
};
Then, create your site with Netlify.
사이트 설정을 위해 다음과 같은 빌드 명령과 디렉터리를 지정해주세요.
- build command:
npm run build
- publish directory:
build
If you did not configure these build options, you may still go to "Site settings" -> "Build & deploy" after your site is created.
Once properly configured with the above options, your site should deploy and automatically redeploy upon merging to your deploy branch, which defaults to main
.
Some Docusaurus sites put the docs
folder outside of website
(most likely former Docusaurus v1 sites):
repo # git root
├── docs # MD files
└── website # Docusaurus root
If you decide to use the website
folder as Netlify's base directory, Netlify will not trigger builds when you update the docs
folder, and you need to configure a custom ignore
command:
[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.
Be very careful: the Disable asset optimization
global checkbox is broken and does not really disable the Pretty URLs
setting in practice. Please make sure to uncheck it independently.
If you want to keep the Pretty Urls
Netlify setting on, adjust the trailingSlash
Docusaurus config appropriately.
Refer to slorber/trailing-slash-guide for more information.
Deploying to Vercel
Deploying your Docusaurus project to Vercel will provide you with various benefits in the areas of performance and ease of use.
To deploy your Docusaurus project with a Vercel for Git Integration, make sure it has been pushed to a Git repository.
Import the project into Vercel using the Import Flow. During the import, you will find all relevant options preconfigured for you; however, you can choose to change any of these options.
After your project has been imported, all subsequent pushes to branches will generate Preview Deployments, and all changes made to the Production Branch (usually "main" or "master") will result in a Production Deployment.
Deploying to GitHub Pages
Docusaurus provides an easy way to publish to GitHub Pages, which comes free with every GitHub repository.
Overview
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. In the following tutorial, they will be referred to as "source" and "deployment", respectively.
각각의 깃허브 저장소는 깃허브 페이지 서비스와 연결됩니다. If the deployment repository is called my-org/my-project
(where my-org
is the organization name or username), the deployed site will appear at 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/
.
In case you want to use your custom domain for GitHub Pages, create a CNAME
file in the static
directory. Anything within the static
directory will be copied to the root of the build
directory for deployment. When using a custom domain, you should be able to move back from baseUrl: '/projectName/'
to baseUrl: '/'
, and also set your url
to your custom domain.
You may refer to GitHub Pages' documentation User, Organization, and Project Pages for more details.
GitHub Pages picks up deploy-ready files (the output from docusaurus build
) from the default branch (master
/ main
, usually) or the gh-pages
branch, and either from the root or the /docs
folder. You can configure that through Settings > Pages
in your repository. 이 브랜치를 "배포 브랜치"라고 합니다.
We provide a docusaurus deploy
command that helps you deploy your site from the source branch to the deployment branch in one command: clone, build, and commit.
docusaurus.config.js
settings
First, modify your docusaurus.config.js
and add the following params:
옵션명 | 설명 |
---|---|
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에 트레일링 슬래시를 기본적으로 추가합니다. It is recommended to set a trailingSlash
config (true
or false
, not undefined
).
예:
export default {
// ...
url: 'https://endiliey.github.io', // Your website URL
baseUrl: '/',
projectName: 'endiliey.github.io',
organizationName: 'endiliey',
trailingSlash: false,
// ...
};
By default, GitHub Pages runs published files through Jekyll. Since Jekyll will discard any files that begin with _
, it is recommended that you disable Jekyll by adding an empty file named .nojekyll
file to your static
directory.
Environment settings
옵션명 | 설명 |
---|---|
USE_SSH | Set to true to use SSH instead of the default HTTPS for the connection to the GitHub repo. If the source repo URL is an SSH URL (e.g. [email protected]:facebook/docusaurus.git ), USE_SSH is inferred to be true . |
GIT_USER | The username for a GitHub account that has push access to the deployment repo. 여러분이 소유자인 저장소라면 사용하고 있는 깃허브 사용자명을 설정합니다. SSH를 사용하지 않는다면 필수이며 그렇지 않은 경우에는 무시됩니다. |
GIT_PASS | Personal access token of the git user (specified by GIT_USER ), to facilitate non-interactive deployment (e.g. continuous deployment) |
CURRENT_BRANCH | 소스 브랜치. Usually, the branch will be main or master , but it could be any branch except for gh-pages . If nothing is set for this variable, then the current branch from which docusaurus deploy is invoked will be used. |
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 | 깃허브 엔터프라이즈 사이트에서 사용하는 포트를 설정합니다. |
Deploy
이제 아래 명령을 사용해 여러분의 사이트를 깃허브 페이지로 배포합니다.
- 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'
Beginning in August 2021, GitHub requires every command-line sign-in to use the personal access token instead of the password. 깃허브에서 암호를 묻는 메시지가 표시되면 PAT를 대신 입력하세요. See the GitHub documentation for more information.
Alternatively, you can use SSH (USE_SSH=true
) to log in.