배포
웹 사이트에 게시할 파일을 빌드하기 위해서 아래 명령을 실행합니다.
- 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.
Triggering deployment with GitHub Actions
GitHub Actions allow you to automate, customize, and execute your software development workflows right in your repository.
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.
우리의 목표는 다음과 같습니다.
- When a new pull request is made to
main
, there's an action that ensures the site builds successfully, without actually deploying. This job will be calledtest-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. This job will be calleddeploy
.
다음은 깃허브 액션을 사용해 문서를 배포하는 두 가지 접근 방식입니다. Based on the location of your deployment repository, choose the relevant tab below:
- Source repo and deployment repo are the same repository.
- The deployment repo is a remote repository, different from the source. 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 다음 두 개의 워크플로 파일을 추가합니다. 이 파일 설정은 Yarn을 사용하고 있다고 전제합니다. If you use npm, change If your Docusaurus project is not at the root of your repo, you may need to configure a default working directory, and adjust the paths accordingly.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. 따라서 대신 별도의 워크플로로 관리할 것을 제안합니다.GitHub action files
cache: yarn
, yarn install --frozen-lockfile
, yarn build
to cache: npm
, npm ci
, npm run build
accordingly.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@v4name: 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 인증을 사용합니다.
- Generate a new SSH key. SSH 키는 CI에서 사용되므로 암호를 입력하지 마세요.
- By default, your public key should have been created in
~/.ssh/id_rsa.pub
; otherwise, use the name you've provided in the previous step to add your key to GitHub deploy keys. - Copy the key to clipboard with
pbcopy < ~/.ssh/id_rsa.pub
and paste it as a deploy key in the deployment repository. 명령행 도구를 사용하기 곤란하다면 파일 콘텐츠를 복사할 수 있습니다. Check the box forAllow write access
before saving your deployment key. - You'll need your private key as a GitHub secret to allow Docusaurus to run the deployment for you.
- Copy your private key with
pbcopy < ~/.ssh/id_rsa
and paste a GitHub secret with the nameGH_PAGES_DEPLOY
on your source repository. 명령행 도구를 사용하기 곤란하다면 파일 콘텐츠를 복사할 수 있습니다. 보안 설정을 저장합니다. - Create your documentation workflow in the
.github/workflows/
directory. In this example it's thedeploy.yml
file.
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.
GitHub action file
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. If you use npm, change cache: yarn
, yarn install --frozen-lockfile
, yarn build
to cache: npm
, npm ci
, npm run build
accordingly.
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
Site not deployed properly?
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.
Triggering deployment with Travis CI
Continuous integration (CI) services are typically used to perform routine tasks whenever new commits are checked in to source control. These tasks can be any combination of running unit tests and integration tests, automating builds, publishing packages to npm, and deploying changes to your website. All you need to do to automate the deployment of your website is to invoke the yarn deploy
script whenever your website is updated. The following section covers how to do just that using Travis CI, a popular continuous integration service provider.
- Go to https://github.com/settings/tokens and generate a new personal access token. When creating the token, grant it the
repo
scope so that it has the permissions it needs. - Using your GitHub account, add the Travis CI app to the repository you want to activate.
- 트래비스 CI 대시보드를 실행합니다. The URL looks like
https://travis-ci.com/USERNAME/REPO
, and navigate to theMore options > Setting > Environment Variables
section of your repository. - Create a new environment variable named
GH_TOKEN
with your newly generated token as its value, thenGH_EMAIL
(your email address) andGH_NAME
(your GitHub username). - Create a
.travis.yml
on the root of your repository with the following:
language: node_js
node_js:
- 18
branches:
only:
- main
cache:
yarn: true
script:
- git config --global user.name "${GH_NAME}"
- git config --global user.email "${GH_EMAIL}"
- echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
- yarn install
- GIT_USER="${GH_NAME}" yarn deploy
Now, whenever a new commit lands in main
, Travis CI will run your suite of tests and if everything passes, your website will be deployed via the yarn deploy
script.
Triggering deployment with Buddy
Buddy is an easy-to-use CI/CD tool that allows you to automate the deployment of your portal to different environments, including GitHub Pages.
Follow these steps to create a pipeline that automatically deploys a new version of your website whenever you push changes to the selected branch of your project:
- Go to https://github.com/settings/tokens and generate a new personal access token. When creating the token, grant it the
repo
scope so that it has the permissions it needs. - Buddy 계정에 로그인하고 새 프로젝트를 만듭니다.
- 깃헙을 깃 호스팅 공급자로 선택하고 웹 사이트 코드가 있는 저장소를 선택합니다.
- Using the left navigation panel, switch to the
Pipelines
view. - 새 파이프 라인을 만듭니다. Define its name, set the trigger mode to
On push
, and select the branch that triggers the pipeline execution. - Add a
Node.js
action. - 작업 터미널에 아래 명령을 추가합니다.
GIT_USER=<GH_PERSONAL_ACCESS_TOKEN>
git config --global user.email "<YOUR_GH_EMAIL>"
git config --global user.name "<YOUR_GH_USERNAME>"
yarn deploy
After creating this simple pipeline, each new commit pushed to the branch you selected deploys your website to GitHub Pages using yarn deploy
. Read this guide to learn more about setting up a CI/CD pipeline for Docusaurus.
Using Azure Pipelines
- Sign Up at Azure Pipelines if you haven't already.
- 그룹 계정 만들기 그룹 계정(organization)으로 프로젝트를 만듭니다. 그리고 깃허브 저장소를 연결합니다.
- Go to https://github.com/settings/tokens and generate a new personal access token with the
repo
scope. - In the project page (which looks like
https://dev.azure.com/ORG_NAME/REPO_NAME/_build
), create a new pipeline with the following text. Also, click on edit and add a new environment variable namedGH_TOKEN
with your newly generated token as its value, thenGH_EMAIL
(your email address) andGH_NAME
(your GitHub username). 환경 변수는 secret로 설정되어야 합니다. Alternatively, you can also add a file namedazure-pipelines.yml
at your repository root.
trigger:
- main
pool:
vmImage: ubuntu-latest
steps:
- checkout: self
persistCredentials: true
- task: NodeTool@0
inputs:
versionSpec: '18'
displayName: Install Node.js
- script: |
git config --global user.name "${GH_NAME}"
git config --global user.email "${GH_EMAIL}"
git checkout -b main
echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
yarn install
GIT_USER="${GH_NAME}" yarn deploy
env:
GH_NAME: $(GH_NAME)
GH_EMAIL: $(GH_EMAIL)
GH_TOKEN: $(GH_TOKEN)
displayName: Install and build
Using Drone
- Create a new SSH key that will be the deploy key for your project.
- Name your private and public keys to be specific and so that it does not overwrite your other SSH keys.
- Go to
https://github.com/USERNAME/REPO/settings/keys
and add a new deploy key by pasting in the public key you just generated. - 드론 CI 대시보드에 로그인합니다. The URL looks like
https://cloud.drone.io/USERNAME/REPO
. - Click on the repository, click on activate repository, and add a secret called
git_deploy_private_key
with your private key value that you just generated. - Create a
.drone.yml
on the root of your repository with the below text.
kind: pipeline
type: docker
trigger:
event:
- tag
- name: Website
image: node
commands:
- mkdir -p $HOME/.ssh
- ssh-keyscan -t rsa github.com >> $HOME/.ssh/known_hosts
- echo "$GITHUB_PRIVATE_KEY" > "$HOME/.ssh/id_rsa"
- chmod 0600 $HOME/.ssh/id_rsa
- cd website
- yarn install
- yarn deploy
environment:
USE_SSH: true
GITHUB_PRIVATE_KEY:
from_secret: git_deploy_private_key
Now, whenever you push a new tag to GitHub, this trigger will start the drone CI job to publish your website.
Deploying to Flightcontrol
Flightcontrol is a service that automatically builds and deploys your web apps to AWS Fargate directly from your Git repository. It gives you full access to inspect and make infrastructure changes without the limitations of a traditional PaaS.
Get started by following Flightcontrol's step-by-step Docusaurus guide.
Deploying to Koyeb
Koyeb is a developer-friendly serverless platform to deploy apps globally. The platform lets you seamlessly run Docker containers, web apps, and APIs with git-based deployment, native autoscaling, a global edge network, and built-in service mesh and discovery. Check out the Koyeb's Docusaurus deployment guide to get started.
Deploying to Render
Render offers free static site hosting with fully managed SSL, custom domains, a global CDN, and continuous auto-deploy from your Git repo. Get started in just a few minutes by following Render's guide to deploying Docusaurus.
Deploying to Qovery
Qovery is a fully-managed cloud platform that runs on your AWS, Digital Ocean, and Scaleway account where you can host static sites, backend APIs, databases, cron jobs, and all your other apps in one place.
- Qovery 계정을 만듭니다. Visit the Qovery dashboard to create an account if you don't already have one.
- 프로젝트를 만듭니다.
- Click on Create project and give a name to your project.
- Click on Next.
- 새 환경을 생성합니다.
- Click on Create environment and give a name (e.g. staging, production).
- 애플리케이션을 추가합니다.
- Click on Create an application, give a name and select your GitHub or GitLab repository where your Docusaurus app is located.
- 메인 브랜치 이름과 루트 애플리케이션 경로를 설정합니다.
- Click on Create. 애플리케이션이 만들어진 후에는
- Navigate to your application Settings
- Select Port
- 도큐사우루스 애플리케이션에서 사용하는 포트를 추가합니다.
- 배포
- All you have to do now is to navigate to your application and click on Deploy.
That's it. Watch the status and wait till the app is deployed. To open the application in your browser, click on Action and Open in your application overview.
Deploying to Hostman
Hostman allows you to host static websites for free. Hostman automates everything, you just need to connect your repository and follow these easy steps:
-
Create a service.
- To deploy a Docusaurus static website, click Create in the top-left corner of your Dashboard and choose Front-end app or static website.
-
Select the project to deploy.
-
If you are logged in to Hostman with your GitHub, GitLab, or Bitbucket account, you will see the repository with your projects, including the private ones.
-
Choose the project you want to deploy. It must contain the directory with the project's files (e.g.
website
). -
To access a different repository, click Connect another repository.
-
If you didn't use your Git account credentials to log in, you'll be able to access the necessary account now, and then select the project.
-
-
Configure the build settings.
-
Next, the Website customization window will appear. Choose the Static website option from the list of frameworks.
-
The Directory with app points at the directory that will contain the project's files after the build. If you selected the repository with the contents of the website (or
my_website
) directory during Step 2, you can leave it empty. -
The standard build command for Docusaurus is:
- npm
- Yarn
- pnpm
npm run build
yarn build
pnpm run build
-
You can modify the build command if needed. You can enter multiple commands separated by
&&
.
-
-
Deploy.
-
Click Deploy to start the build process.
-
Once it starts, you will enter the deployment log. If there are any issues with the code, you will get warning or error messages in the log specifying the cause of the problem. Usually, the log contains all the debugging data you'll need.
-
When the deployment is complete, you will receive an email notification and also see a log entry. All done! Your project is up and ready.
-
Deploying to Surge
Surge is a static web hosting platform that you can use to deploy your Docusaurus project from the command line in seconds. Deploying your project to Surge is easy and free (including custom domains and SSL certs).
Deploy your app in a matter of seconds using Surge with the following steps:
- First, install Surge using npm by running the following command:
- npm
- Yarn
- pnpm
npm install -g surge
yarn global add surge
pnpm add -g surge
- To build the static files of your site for production in the root directory of your project, run:
- npm
- Yarn
- pnpm
npm run build
yarn build
pnpm run build
- Then, run this command inside the root directory of your project:
surge build/
First-time users of Surge would be prompted to create an account from the command line (which happens only once).
Confirm that the site you want to publish is in the build
directory. A randomly generated subdomain *.surge.sh subdomain
is always given (which can be edited).
Using your domain
If you have a domain name you can deploy your site using the command:
surge build/ your-domain.com
Your site is now deployed for free at subdomain.surge.sh
or your-domain.com
depending on the method you chose.
Setting up CNAME file
Store your domain in a CNAME file for future deployments with the following command:
echo subdomain.surge.sh > CNAME
You can deploy any other changes in the future with the command surge
.
Deploying to Stormkit
You can deploy your Docusaurus project to Stormkit, a deployment platform for static websites, single-page applications (SPAs), and serverless functions. For detailed instructions, refer to this guide.
Deploying to QuantCDN
- Install Quant CLI
- Create a QuantCDN account by signing up
- Initialize your project with
quant init
and fill in your credentials:quant init
- Deploy your site.
quant deploy
See docs and blog for more examples and use cases for deploying to QuantCDN.
Deploying to Layer0
Layer0 is an all-in-one platform to develop, deploy, preview, experiment on, monitor, and run your headless frontend. It is focused on large, dynamic websites and best-in-class performance through EdgeJS (a JavaScript-based Content Delivery Network), predictive prefetching, and performance monitoring. Layer0 offers a free tier. Get started in just a few minutes by following Layer0's guide to deploying Docusaurus.
Deploying to Cloudflare Pages
Cloudflare Pages is a Jamstack platform for frontend developers to collaborate and deploy websites. Get started within a few minutes by following this article.
Deploying to Azure Static Web Apps
Azure Static Web Apps is a service that automatically builds and deploys full-stack web apps to Azure directly from the code repository, simplifying the developer experience for CI/CD. Static Web Apps separates the web application's static assets from its dynamic (API) endpoints. Static assets are served from globally-distributed content servers, making it faster for clients to retrieve files using servers nearby. Dynamic APIs are scaled with serverless architectures using an event-driven functions-based approach that is more cost-effective and scales on demand. Get started in a few minutes by following this step-by-step guide.
Deploying to Kinsta
Kinsta Static Site Hosting lets you deploy up to 100 static sites for free, custom domains with SSL, 100 GB monthly bandwidth, and 260+ Cloudflare CDN locations.
Get started in just a few clicks by following our Docusaurus on Kinsta article.