Skip to content

docs(en): merge docs-cn/sync-docs into docs-cn/dev @ dced02c8 #1217

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 4 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions guide/rolldown.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,17 @@ Rolldown 专注于三个主要原则:

如果你想进行实时讨论和故障排除,请确保加入 [Rolldown Discord](https://chat.rolldown.rs/)。

<<<<<<< HEAD
## 未来计划 {#future-plans}
=======
## Versioning Policy

The versioning policy for `rolldown-vite` aligns its major and minor versions with those of the normal Vite package. This synchronization ensures that features present in a specific normal Vite minor release are also included in the corresponding `rolldown-vite` minor release. However, it's important to note that patch versions are not synchronized between the two projects. If you're wondering whether a specific change from normal Vite has been included in `rolldown-vite`, you can always check [`rolldown-vite`'s separate changelog](https://github.com/vitejs/rolldown-vite/blob/rolldown-vite/packages/vite/CHANGELOG.md) for confirmation.

Furthermore, please be aware that `rolldown-vite` itself is considered experimental. Due to its experimental nature, breaking changes might be introduced even within its patch versions. Additionally, please note that `rolldown-vite` only receives updates for its most recent minor version. Even for important security or bug fixes, patches are not created for older major or minor versions.

## Future Plans
>>>>>>> dced02c810c5a39bb9e5e98318ae19d57315ef39

`rolldown-vite` 包是一个临时的解决方案,用于收集反馈和稳定 Rolldown 的集成。在未来,这个功能将被合并回主 Vite 仓库。

Expand Down
56 changes: 56 additions & 0 deletions guide/static-deploy-github-pages.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
# Imported in static-deploy.md
# This file is extracted as a separate file so that renovate can update the action versions
#
#region content
# Simple workflow for deploying static content to GitHub Pages
name: Deploy static content to Pages

on:
# Runs on pushes targeting the default branch
push:
branches: ['main']

# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:

# Sets the GITHUB_TOKEN permissions to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write

# Allow one concurrent deployment
concurrency:
group: 'pages'
cancel-in-progress: true

jobs:
# Single deploy job since we're just deploying
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Set up Node
uses: actions/setup-node@v4
with:
node-version: lts/*
cache: 'npm'
- name: Install dependencies
run: npm ci
- name: Build
run: npm run build
- name: Setup Pages
uses: actions/configure-pages@v4
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
# Upload dist folder
path: './dist'
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
#endregion content
4 changes: 4 additions & 0 deletions guide/static-deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,7 @@ $ npm run preview

2. 进入仓库 settings 页面的 GitHub Pages 配置,选择部署来源为“GitHub Actions”,这将引导你创建一个构建和部署项目的工作流程,我们提供了一个安装依赖项和使用 npm 构建的工作流程样本:

<<<<<<< HEAD
```yml
# 将静态内容部署到 GitHub Pages 的简易工作流程
name: Deploy static content to Pages
Expand Down Expand Up @@ -116,6 +117,9 @@ $ npm run preview
id: deployment
uses: actions/deploy-pages@v4
```
=======
<<< ./static-deploy-github-pages.yaml#content
>>>>>>> dced02c810c5a39bb9e5e98318ae19d57315ef39

## GitLab Pages 配合 GitLab CI {#gitlab-pages-and-gitlab-ci}

Expand Down
20 changes: 20 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
{
<<<<<<< HEAD
"name": "vite-docs-cn",
"version": "1.0.0",
"description": "Vite.js documentation Chinese translation.",
Expand Down Expand Up @@ -33,4 +34,23 @@
"gitHooks": {
"commit-msg": "node scripts/verifyCommit.js"
}
=======
"name": "docs",
"private": true,
"type": "module",
"scripts": {
"docs": "vitepress dev",
"docs-build": "vitepress build",
"docs-serve": "vitepress serve"
},
"devDependencies": {
"@shikijs/vitepress-twoslash": "^2.5.0",
"@types/express": "^4.17.21",
"feed": "^4.2.2",
"vitepress": "^1.6.3",
"vitepress-plugin-group-icons": "^1.5.2",
"vitepress-plugin-llms": "^1.1.0",
"vue": "^3.5.13"
}
>>>>>>> dced02c810c5a39bb9e5e98318ae19d57315ef39
}