markdown doc (#538)","coAuthors":[{"name":"pengzhanbo","email":"volodymyr@foxmail.com"}]},{"hash":"a4ac3a30e0b74175b3cd4fd82c52b2321b013926","time":1741490087000,"email":"95458562+zhenghaoyang24@users.noreply.github.com","author":"zhenghaoyang24","message":"docs: add en-US docs (#514)","coAuthors":[{"name":"pengzhanbo","email":"volodymyr@foxmail.com"}]}]},"autoDesc":true,"filePathRelative":"en/guide/quick-start/deployment.md","headers":[],"bulletin":false}`),l={name:`deployment.md`},u={class:`vp-steps`},d={class:`code-block-title`,"data-title":`firebase.json`},f={class:`code-block-title-bar`},p={class:`title`},m={class:`code-block-title`,"data-title":`.firebaserc`},h={class:`code-block-title-bar`},g={class:`title`},_={class:`vp-steps`},v={class:`code-block-title`,"data-title":`static.json`},y={class:`code-block-title-bar`},b={class:`title`};function x(s,c,l,x,S,C){let w=e(`VPIcon`);return t(),r(`div`,null,[c[12]||=a(`This document is forked from the vuepress official doc.
The following guides are based on the following assumptions:
docs directory of your project..vuepress/dist) is used.package.json:{
"scripts": {
"docs:build": "vuepress build docs"
}
}Set the correct base option.
If you are deploying to https://<USERNAME>.github.io/, you can omit this step as base defaults to "/".
If you are deploying to https://<USERNAME>.github.io/<REPO>/, meaning your repository address is https://github.com/<USERNAME>/<REPO>, then set base to "/<REPO>/".
Choose your preferred CI tool. Here we use GitHub Actions as an example.
Create a .github/workflows/docs.yml file to configure the workflow.
name: docs
on:
# Trigger deployment on every push to the main branch
push:
branches: [main]
# Allow manual triggering
workflow_dispatch:
jobs:
docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
# Fetch all commit history for info like 'last updated'
fetch-depth: 0
- name: Setup pnpm
uses: pnpm/action-setup@v4
with:
# Choose the pnpm version to use
version: 10
# Use pnpm to install dependencies
run_install: true
- name: Setup Node.js
uses: actions/setup-node@v4
with:
# Choose the Node.js version to use
node-version: 22
# Cache pnpm dependencies
cache: pnpm
# Run the build script
- name: Build VuePress site
run: pnpm docs:build
# See https://github.com/crazy-max/ghaction-github-pages for more info
- name: Deploy to GitHub Pages
uses: crazy-max/ghaction-github-pages@v4
with:
# Deploy to the gh-pages branch
target_branch: gh-pages
# Deployment directory is VuePress's default output directory
build_dir: docs/.vuepress/dist
env:
# @see https://docs.github.com/en/actions/security-guides/automatic-token-authentication#about-the-github_token-secret
GITHUB_TOKEN: \${{ secrets.GITHUB_TOKEN }}Please refer to the GitHub Pages official guide for more information.
Set the correct base option.
If you are deploying to https://<USERNAME>.gitlab.io/, you can omit this step as base defaults to "/".
If you are deploying to https://<USERNAME>.gitlab.io/<REPO>/, meaning your repository address is https://gitlab.com/<USERNAME>/<REPO>, then set base to "/<REPO>/".
Create a .gitlab-ci.yml file to configure the GitLab CI workflow.
# Choose the docker image to use
image: node:22-buster
pages:
# Trigger deployment on every push to the main branch
only:
- main
# Cache node_modules
cache:
key:
files:
- pnpm-lock.yaml
paths:
- .pnpm-store
# Install pnpm
before_script:
- curl -fsSL https://get.pnpm.io/install.sh | sh -
- pnpm config set store-dir .pnpm-store
# Install dependencies and run the build script
script:
- pnpm install --frozen-lockfile
- pnpm docs:build --dest public
artifacts:
paths:
- publicPlease refer to the GitLab Pages official guide for more information.
{
"hosting": {
"public": "./docs/.vuepress/dist",
"ignore": []
}
}{
"projects": {
"default": "<YOUR_FIREBASE_ID>"
}
}Please refer to the Firebase CLI official guide for more information.
First, install the Heroku CLI.
Create a Heroku account here site.
Run heroku login and fill in your Heroku credentials:
heroku login{
"root": "./docs/.vuepress/dist"
}Please check Set Up VuePress on Kinsta.
Please check Edgio Documentation > Framework Guides > VuePress.
Go to Netlify, create a new project from GitHub, and configure it as follows:
pnpm docs:builddocs/.vuepress/distSet Environment variables to select the Node.js version:
NODE_VERSION: 22Click the deploy button.
Go to Vercel, create a new project from GitHub, and configure it as follows:
Otherpnpm docs:builddocs/.vuepress/distClick the deploy button.
CloudBase is a cloud-native, integrated Serverless cloud platform that supports various hosting capabilities like static websites and containers. It provides an easy deployment tool, CloudBase Framework, for one-click application deployment.
Install CloudBase CLI globally:
pnpm install -g @cloudbase/cliRun the following command in your project's root directory to deploy the VuePress application with one click. You can first activate an environment before deployment:
cloudbase init --without-template
cloudbase framework:deployThe CloudBase CLI will first redirect to the console for login authorization and then proceed with an interactive confirmation.
After confirmation, deployment will begin immediately. Once completed, you will get a website application with automatic SSL and CDN acceleration. You can also use GitHub Action for continuous deployment of your VuePress application on GitHub.
You can also use cloudbase init --template vuepress to quickly create and deploy a new VuePress application.
Tips
For more detailed information, please check the deployment project examples in the CloudBase Framework documentation.
Please check 21 YunBox - Deploy a VuePress Static Site.
`,17)])}var S=s(l,[[`render`,x]]);export{c as _pageData,S as default};