Déploiement
Pour construire les fichiers statiques de votre site web pour la production, exécutez :
- 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
.
C'est maintenant à vous de choisir comment héberger ces fichiers statiques.
You can deploy your site to static site hosting services such as Vercel, GitHub Pages, Netlify, Render, Surge...
Un site Docusaurus est rendu de manière statique, et il peut généralement fonctionner sans JavaScript !
Configuration
The following parameters are required in docusaurus.config.js
to optimize routing and serve files from the correct location:
Nom | Description |
---|---|
url | URL de votre site. For a site deployed at https://my-org.com/my-project/ , url is https://my-org.com/ . |
baseUrl | URL de base pour votre projet, avec un slash à la fin. For a site deployed at https://my-org.com/my-project/ , baseUrl is /my-project/ . |
Testing your Build Locally
Il est important de tester votre construction avant de le déployer pour la production. 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.
La valeur par défaut fonctionne généralement bien. Unfortunately, each static hosting provider has a different behavior, and deploying the exact same site to various hosts can lead to distinct results. En fonction de votre hôte, il peut être utile de modifier cette configuration.
Use slorber/trailing-slash-guide to understand better the behavior of your host and configure trailingSlash
appropriately.
Using environment variables
Placer des informations potentiellement sensibles dans l'environnement est une pratique courante. 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... are client side and do not have direct access to the process
global. In this case, you can consider using customFields
to pass environment variables to the client side.
// Si vous utilisez dotenv (https://www.npmjs.com/package/dotenv)
require('dotenv').config();
module.exports = {
title: '...',
url: process.env.URL, // Vous pouvez également utiliser des variables d'environnement pour contrôler les spécificités du site
customFields: {
// Mettez votre environnement personnalisé ici
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
Il existe quelques options d'hébergement courantes :
- Self hosting with an HTTP server like Apache2 or Nginx;
- Jamstack providers, e.g. Netlify and Vercel. Nous les utiliserons comme références, mais le même raisonnement peut s'appliquer à d'autres fournisseurs.
- GitHub Pages. (Par définition, il s'agit aussi de Jamstack, mais nous le comparons séparément.)
Si vous n'êtes pas certain de savoir lequel choisir, posez-vous les questions suivantes :
How much resource (person-hours, money) am I willing to invest in this?
- 🔴 L'auto-hébergement est le plus difficile à mettre en place — vous aurez généralement besoin d'une personne expérimentée pour gérer cela. Les services Cloud ne sont presque jamais gratuits, et configurer un serveur sur place et le connecter au WAN peut être plus coûteux.
- 🟢 Les fournisseurs de Jamstack peuvent vous aider à configurer un site web fonctionnel en un rien de temps et offrent des fonctionnalités comme les redirections côté serveur qui sont facilement configurables. De nombreux fournisseurs offrent de généreux quotas de temps de construction, même pour les plans gratuits, que vous ne dépasserez presque jamais. Cependant, il reste en fin de compte limité, vous devrez payer une fois que vous aurez atteint la limite. Consultez la page tarifaire de votre fournisseur pour plus de détails.
- 🟡 Le workflow de déploiement des pages GitHub peut être fastidieux à configurer. (Evidence: see the length of Deploying to GitHub Pages!) Cependant, ce service (y compris la construction et le déploiement) est toujours gratuit pour les dépôts publics, et nous avons des instructions détaillées pour vous aider à le faire fonctionner.
How much server-side configuration would I need?
- 🟢 Avec l'auto-hébergement, vous avez accès à toute la configuration du serveur. Vous pouvez configurer l'hôte virtuel pour qu'il serve différents contenus en fonction de l'URL de la requête; vous pouvez faire des redirections compliquées côté serveur; vous pouvez mettre une partie du site derrière l'authentification... Si vous avez besoin de nombreuses fonctionnalités côté serveur, hébergez votre site web.
- 🟡 Jamstack propose généralement certaines configurations côté serveur, par exemple le formatage des URL (slash de fin de chaîne), les redirections côté serveur...
- 🔴 Les Pages GitHub n'exposent pas les configurations côté serveur, à part l'application du HTTPS et la définition du CNAME.
Do I have needs to cooperate?
- 🟡 Les services auto-hébergés peuvent atteindre le même effet que Netlify, mais avec beaucoup plus de lourdeur. En général, c'est une personne spécifique qui s'occupe du déploiement, et le processus n'est pas vraiment basé sur git, contrairement aux deux autres options.
- 🟢 Netlify et Vercel ont des aperçus de déploiement pour chaque pull request, ce qui est utile pour une équipe pour revoir le travail avant de le mettre en production. Vous pouvez également gérer une équipe avec un accès différent au déploiement.
- 🟡 Les pages GitHub ne peuvent pas faire des aperçus de déploiement d'une manière simple. Un dépôt ne peut être associé qu'à un seul déploiement du site. D'un autre côté, vous pouvez contrôler qui a accès en écriture au déploiement du site.
Il n'y a pas de solution miracle. Vous devez évaluer vos besoins et vos ressources avant de faire votre choix.
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
Ce n'est pas la meilleure option, par rapport à un fournisseur d'hébergement statique / CDN.
Dans les sections suivantes, nous allons présenter quelques fournisseurs d'hébergement les plus courants et la manière dont ils doivent être configurés pour déployer les sites Docusaurus le plus efficacement possible. Certains textes sont fournis par des contributeurs externes. Docusaurus n'est lié à aucun des services. La documentation peut ne pas être à jour : les modifications récentes de leur API peuvent ne pas être reprises de notre côté. Si vous voyez du contenu obsolète, les PR sont les bienvenues.
Dans le même souci de mise à jour, nous avons cessé d'accepter les PR ajoutant de nouvelles options d'hébergement. Vous pouvez toutefois publier votre article sur un autre site (par exemple, votre blog ou le site officiel du fournisseur) et nous demander d'inclure un lien vers votre texte.
Deploying to Netlify
To deploy your Docusaurus 2 sites to Netlify, first make sure the following options are properly configured:
module.exports = {
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.
Pendant que vous configurez le site, spécifiez les commandes de compilation et les répertoires comme suit :
- 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 # racine git
├── docs # fichiers MD
└── website # racine Docusaurus
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/"
Par défaut, Netlify ajoute un slash final aux URL Docusaurus.
It is recommended to disable the Netlify setting Post Processing > Asset Optimization > Pretty Urls
to prevent lowercased 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, a list of which can be found here.
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 for free with every GitHub repository.
Overview
Habituellement, il y a deux dépôts (au moins deux branches) impliqués dans un processus de publication : la branche contenant les fichiers source, et la branche contenant la sortie de construction à servir avec GitHub Pages. In the following tutorial, they will be referred to as "source" and "deployment", respectively.
Chaque dépôt GitHub est associé à un service GitHub pages. 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/
. Specially, 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. Cette branche sera appelée "branche de déploiement".
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:
Nom | Description |
---|---|
organizationName | L'utilisateur ou l'organisation GitHub qui possède le dépôt de déploiement. |
projectName | Le nom du dépôt de déploiement. |
deploymentBranch | Le nom de la branche de déploiement. Defaults to 'gh-pages' for non-organization GitHub Pages repos (projectName not ending in .github.io ). Sinon, cela doit être explicite comme un champ de configuration ou une variable d'environnement. |
These fields also have their environment variable counterparts, which have a higher priority: ORGANIZATION_NAME
, PROJECT_NAME
, and DEPLOYMENT_BRANCH
.
GitHub Pages ajoute par défaut un slash final aux URL Docusaurus. It is recommended to set a trailingSlash
config (true
or false
, not undefined
).
Exemple :
module.exports = {
// ...
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
Nom | Description |
---|---|
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. Pour vos propres dépôts, ce sera généralement votre nom d'utilisateur GitHub. Requis si vous n'utilisez pas SSH, et ignoré autrement. |
GIT_PASS | Personal access token of the git user (specified by GIT_USER ), to facilitate non-interactive deployment (e.g. continuous deployment) |
CURRENT_BRANCH | La branche source. 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. |
Les installations de GitHub Enterprise devraient fonctionner de la même manière que github.com ; il suffit de définir l'hôte GitHub Enterprise de l'organisation comme variable d'environnement :
Nom | Description |
---|---|
GITHUB_HOST | Le nom de domaine de votre site d'entreprise GitHub. |
GITHUB_PORT | Le port de votre site d'entreprise GitHub. |
Deploy
Enfin, pour déployer votre site sur GitHub Pages, exécutez :
- 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. Lorsque GitHub vous demande votre mot de passe, entrez le PAT à la place. 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 the gh-pages
branch (the deployment branch is gh-pages
).
Notre objectif est que :
- 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 thegh-pages
branch. Après cela, la nouvelle sortie sera distribuée sur le site des Pages GitHub. This job will be calleddeploy
.
Voici deux approches pour déployer votre documentation avec GitHub Actions. Based on the location of your deployment branch (gh-pages
), 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.
- 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 communicative of the actual status and provides no value to the review process. Nous proposons donc de les gérer en tant que workflow séparés.
We will use a popular third-party deployment action: peaceiris/actions-gh-pages.
GitHub action files
Ajoutez ces deux fichiers de workflow :
Ces fichiers supposent que vous utilisez Yarn. If you use npm, change cache: yarn
, yarn install --frozen-lockfile
, yarn build
to cache: npm
, npm ci
, npm run build
accordingly.
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.
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:
deploy:
name: Deploy to GitHub Pages
runs-on: ubuntu-latest
steps:
- uses: actions/[email protected]
- uses: actions/setup-[email protected]
with:
node-version: 18
cache: yarn
- name: Install dependencies
run: yarn install --frozen-lockfile
- name: Build website
run: yarn build
# Popular action to deploy to GitHub Pages:
# Docs: https://github.com/peaceiris/actions-gh-pages#%EF%B8%8F-docusaurus
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-[email protected]
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
# Build output to publish to the `gh-pages` branch:
publish_dir: ./build
# The following lines assign commit authorship to the official
# GH-Actions bot for deploys to `gh-pages` branch:
# https://github.com/actions/checkout/issues/13#issuecomment-724415212
# The GH actions bot is used by default if you didn't specify the two fields.
# You can swap them out with your own user credentials.
user_name: github-actions[bot]
user_email: 41898282+github-actions[bot]@users.noreply.github.com
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/[email protected]
- uses: actions/setup-[email protected]
with:
node-version: 18
cache: yarn
- name: Install dependencies
run: yarn install --frozen-lockfile
- name: Test build website
run: yarn build
Une publication inter-dépôt est plus difficile à mettre en place, car vous devez pousser vers un autre référentiel avec des contrôles de permission. Nous utiliserons SSH pour l'authentification.
- Generate a new SSH key. Comme cette clé SSH sera utilisée dans le CI, assurez-vous de ne pas saisir de passphrase.
- 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. Copiez le contenu du fichier si la ligne de commande ne fonctionne pas pour vous. 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. Copiez le contenu du fichier si la ligne de commande ne fonctionne pas pour vous. Enregistrez votre secret. - Create your documentation workflow file in
.github/workflows/
. In this example it'sdeploy.yml
. - Vous devriez avoir essentiellement : le dépôt source avec le workflow GitHub défini avec la clé SSH privée comme GitHub Secret et votre dépôt de déploiement défini avec la clé SSH publique dans GitHub Deploy Keys.
GitHub action file
Please make sure that you replace [email protected]
with your GitHub email and gh-actions
with your name.
Ce fichier suppose que vous utilisez 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]
jobs:
test-deploy:
if: github.event_name != 'push'
runs-on: ubuntu-latest
steps:
- uses: actions/[email protected]
- uses: actions/setup-[email protected]
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/[email protected]
- uses: actions/setup-[email protected]
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?
Après avoir poussé vers main, si vous ne voyez pas votre site publié à l'emplacement souhaité (par exemple, il indique « There isn't a GitHub Pages site here », ou il affiche le fichier README.md de votre dépôt), vérifiez ce qui suit :
- Il peut s'écouler quelques minutes avant que les pages GitHub ne détectent les nouveaux fichiers. Attendez environ 3 minutes et actualisez avant de conclure que cela ne fonctionne pas.
- Sur la page d'accueil de votre dépôt, vous devriez voir une petite coche verte à côté du titre du dernier commit, indiquant que le CI est réussi. Si vous voyez une croix, cela signifie que la construction ou le déploiement a échoué, et vous devez vérifier le journal pour plus d'informations de débogage.
- Cliquez sur la coche et assurez-vous que vous voyez un flux de travail « Deploy to GitHub Pages ». Des noms comme « pages build and deployment / deploy » sont des flux de travail par défaut de GitHub, ce qui indique que votre flux de travail de déploiement personnalisé qui a échoué, n'a pas du tout été déclenché. Make sure the YAML files are put under the
.github/workflows
folder, and the trigger condition is set correctly (for example, if your default branch is "master" instead of "main", you need to change theon.push
property). - We are using
gh-pages
as the deployment branch. 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)". - Si vous utilisez un domaine personnalisé, assurez-vous que l'enregistrement DNS pointe vers l'adresse IP des serveurs des pages GitHub.
Triggering deployment with Travis CI
Les services d'intégration continue (CI) sont généralement utilisés pour effectuer des tâches routinières lorsque de nouveaux commits sont enregistrés dans le contrôle de source. Ces tâches peuvent être une combinaison de tests unitaires et de tests d'intégration, d'automatisation de la construction, de publication de paquets sur npm et de déploiement de modifications sur votre site Web. 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.
- Ouvrez votre tableau de bord Travis 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.
Suivez ces étapes pour créer un pipeline qui déploie automatiquement une nouvelle version de votre site Web chaque fois que vous apportez des modifications à la branche sélectionnée de votre projet :
- 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. - Connectez-vous à votre compte Buddy et créez un nouveau projet.
- Choisissez GitHub comme hébergeur git et sélectionnez le dépôt avec le code de votre site web.
- Using the left navigation panel, switch to the
Pipelines
view. - Créez un nouveau pipeline. Define its name, set the trigger mode to
On push
, and select the branch that triggers the pipeline execution. - Add a
Node.js
action. - Ajoutez ces commandes dans le terminal de l'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.
- Créer une organisation. Au sein de l'organisation, créez un projet et connectez votre dépôt à partir de GitHub.
- 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). Assurez-vous de les marquer comme secrets. 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: [email protected]
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. - Ouvrez votre tableau de bord Drone.io et connectez-vous. 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
Maintenant, chaque fois que vous poussez un nouveau tag sur Github, ce déclencheur démarrera la tâche de drone CI pour publier votre site web.
Deploying to Koyeb
Koyeb is a developer-friendly serverless platform to deploy apps globally. La plateforme vous permet d'exécuter de manière transparente des conteneurs Docker, des applications Web et des API avec un déploiement basé sur git, une mise à l'échelle automatique native, un réseau périphérique mondial et un maillage et une découverte de services intégrés. 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.
- Créez un compte Qovery. Visit the Qovery dashboard to create an account if you don't already have one.
- Créez un projet.
- Click on Create project and give a name to your project.
- Click on Next.
- Créez un nouvel environnement.
- Click on Create environment and give a name (e.g. staging, production).
- Ajoutez une application.
- Click on Create an application, give a name and select your GitHub or GitLab repository where your Docusaurus app is located.
- Définissez le nom de la branche principale et le chemin de l'application racine.
- Click on Create. Après la création de l'application :
- Navigate to your application Settings
- Select Port
- Ajoutez le port utilisé par votre application Docusaurus
- Deploy All you have to do now is to navigate to your application and click on Deploy.
Voilà. Regardez le statut et attendez que l'application soit déployée. 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 automatise tout, il vous suffit de connecter votre dépôt et de suivre des étapes faciles :
Créez un 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.
Sélectionnez le projet à déployer.
Si vous êtes connecté à Hostman avec votre compte GitHub, GitLab ou Bitbucket, à ce stade, vous verrez le dépôt avec vos projets, y compris les projets privés.
Choisissez le projet que vous souhaitez déployer. It must contain the directory with the project's files (e.g.
website
).To access a different repository, click Connect another repository.
Si vous n'avez pas utilisé les informations d'identification de votre compte Git pour vous connecter, vous pourrez accéder au compte nécessaire maintenant, puis sélectionner le projet.
Configurez les paramètres de construction.
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. You can leave it empty if during Step 2 you selected the repository with the contents of the website (or
my_website
) directory.La « build command » pour Docusaurus sera :
- npm
- Yarn
- pnpm
npm run build
yarn build
pnpm run build
Vous pouvez modifier la commande de compilation si nécessaire. You can enter multiple commands separated by
&&
.Déployez.
Click Deploy to start the build process.
Une fois qu'il aura démarré, vous entrerez dans le journal de déploiement. En cas de problème avec le code, vous obtiendrez des messages d'avertissement ou d'erreur dans le journal, précisant la cause du problème. Habituellement, le journal contient toutes les données de débogage dont vous aurez besoin.
Une fois le déploiement terminé, vous recevrez une notification par mail et vous verrez également une note du journal. Terminé ! Votre projet est prêt.
Deploying to Surge
Surge is a static web hosting platform, it is used to deploy your Docusaurus project from the command line in a minute. Déployer votre projet sur Surge est facile et il est également gratuit (y compris un domaine personnalisé et SSL).
Déployez votre application en quelques secondes en utilisant surge avec les étapes suivantes :
- Tout d'abord, installez Surge en utilisant npm en exécutant la commande suivante :
- npm
- Yarn
- pnpm
npm install -g surge
yarn global add surge
pnpm add -g surge
- Pour construire pour la production les fichiers statiques de votre site à la racine de votre projet, exécutez :
- npm
- Yarn
- pnpm
npm run build
yarn build
pnpm run build
- Ensuite, exécutez cette commande à l'intérieur du répertoire racine de votre projet :
surge build/
La première fois, les utilisateurs de Surge seront invités à créer un compte à partir de la ligne de commande (cela ne se produit qu'une fois).
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
Si vous avez un nom de domaine, vous pouvez déployer votre site en utilisant la commande :
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
Stockez votre domaine dans un fichier CNAME pour de futurs déploiements avec la commande suivante :
echo subdomain.surge.sh > CNAME
You can deploy any other changes in the future with the command surge
.
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
- Déployez votre 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. Il est axé sur les sites Web dynamiques de grande taille et sur des performances de premier ordre grâce à EdgeJS (un réseau de diffusion de contenu basé sur JavaScript), à la récupération anticipée prédictive et au contrôle des performances. Layer0 offre un niveau gratuit. 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 sépare les ressources statiques de l'application Web de ses points de terminaison dynamiques (API). Les ressources statiques sont servies par des serveurs de contenu répartis dans le monde entier, ce qui permet aux clients de récupérer plus rapidement les fichiers en utilisant des serveurs à proximité. Les API dynamiques sont mises à l'échelle avec des architectures sans serveur, en utilisant une approche basée sur des fonctions événementielles qui est plus rentable et évolue à la demande. Get started in a few minutes by following this step-by-step guide.