{{ title }}
@@ -70,10 +89,10 @@ defineProps({
}
.section-icon {
- width: 40px;
+ font-size: 40px;
@include respond-to('<=laptop') {
- width: 32px;
+ font-size: 32px;
}
}
diff --git a/app/vite.config.ts b/app/vite.config.ts
index 293eaf24b0c0f4b1525bd8a5176e8d0e2c6954f4..514d1673fa22375f232976858a1c40597873677a 100644
--- a/app/vite.config.ts
+++ b/app/vite.config.ts
@@ -3,7 +3,8 @@ import { fileURLToPath, URL } from 'node:url';
import { defineConfig } from 'vitepress';
import Icons from 'unplugin-icons/vite';
import { FileSystemIconLoader } from 'unplugin-icons/loaders';
-import basicSsl from '@vitejs/plugin-basic-ssl';
+
+import replaceUrlPlugin from './.vitepress/plugins/replace-url-plugin';
export default defineConfig({
plugins: [
@@ -16,7 +17,7 @@ export default defineConfig({
feedback: FileSystemIconLoader(fileURLToPath(new URL('./.vitepress/src/assets/category/feedback/svg-icons', import.meta.url))),
},
}),
- // basicSsl(),
+ replaceUrlPlugin(),
],
assetsInclude: ['**/*.PNG'],
build: {
diff --git a/package.json b/package.json
index 011053e32dbcbfc5c0f396c90edcf6d310ff2661..f9d05051c1d3243d25aa935c0b4020b97ea61e41 100644
--- a/package.json
+++ b/package.json
@@ -6,6 +6,7 @@
"pre-dev": "node scripts/pre-dev.js",
"gen-toc": "node scripts/gen-toc.js",
"dev": "vitepress dev app",
+ "dev2": "node scripts/dev.js",
"build": "node scripts/gen-toc.js $VERSION && vitepress build app",
"preview": "vitepress preview app",
"format": "prettier --write app/.vitepress/src/",
diff --git a/scripts/dev.js b/scripts/dev.js
new file mode 100644
index 0000000000000000000000000000000000000000..14654f54f39e4fb6ed2e0f85ba630422c5fb6008
--- /dev/null
+++ b/scripts/dev.js
@@ -0,0 +1,33 @@
+import { exec } from 'child_process';
+
+import NEW_VERSONS from './config/new-version.js';
+
+function execCommand(command) {
+ return new Promise((resolve, reject) => {
+ const child = exec(command, {
+ inherit: true,
+ });
+
+ child.stdout?.pipe(process.stdout);
+ child.stderr?.pipe(process.stderr);
+
+ child.on('close', (code) => {
+ resolve(code);
+ });
+
+ child.on('error', (error) => {
+ reject(error);
+ });
+ });
+}
+
+(async () => {
+ let versions = process.argv.slice(2);
+ if (versions.length === 0) {
+ versions = NEW_VERSONS;
+ }
+
+ await execCommand(`pnpm pre-dev ${versions.join(' ')}`);
+ await execCommand(`pnpm gen-toc ${versions.join(' ')}`);
+ await execCommand(`pnpm dev`);
+})();
diff --git a/scripts/gen-toc.js b/scripts/gen-toc.js
index 85432924660df376738b032a34b5b0d669be96d6..59649caf912333c17ab37e2cb0c224b2ad94fcea 100644
--- a/scripts/gen-toc.js
+++ b/scripts/gen-toc.js
@@ -9,6 +9,7 @@ import yaml from 'js-yaml';
import { slugify } from '@mdit-vue/shared';
import { getGitUrlInfo } from './utils/git.js';
+import { getBranchName } from './utils/common.js';
const __dirname = path.resolve(); // 获取当前文件夹路径
const recordIds = new Set(); // 已处理过的 id
@@ -393,7 +394,8 @@ async function processTocFile() {
const outputZhPath = path.join(__dirname, './app/.vitepress/public/toc/toc.json');
const outputEnPath = path.join(__dirname, './app/.vitepress/public/toc/toc-en.json');
- for (const version of versions) {
+ for (const item of versions) {
+ const version = getBranchName(item);
console.log(`正在构建 ${version} toc 文件...`);
if (version === 'common') {
// common 分支处理
diff --git a/scripts/merge-upstream.js b/scripts/merge-upstream.js
index cc04d24a00bd996aeb8d3226654dbfdf7b429942..0d2742108adea83470037e9b233e4ad0c0455adf 100644
--- a/scripts/merge-upstream.js
+++ b/scripts/merge-upstream.js
@@ -6,7 +6,6 @@ import { getGitUrlInfo, isGitRepo, checkoutBranch } from './utils/git.js';
import { copyDirectorySync } from './utils/file.js';
const REPO_DIR = path.join(process.cwd(), '../../');
-const BUILD_DIR = path.join(process.cwd(), '../../../build');
const copyRepoFromDiskCache = async (upstream, dir, storagePath) => {
const { repo, branch, locations } = getGitUrlInfo(upstream);
@@ -53,9 +52,11 @@ const mergeUpstream = async (targetPath) => {
}
};
-const merge = async () => {
- await mergeUpstream(`${BUILD_DIR}/app/zh/`);
- await mergeUpstream(`${BUILD_DIR}/app/en/`);
+const merge = async (branch) => {
+ const buildPath = path.join(process.cwd(), `../../../build/${branch}`);
+
+ await mergeUpstream(`${buildPath}/app/zh/`);
+ await mergeUpstream(`${buildPath}/app/en/`);
};
const args = process.argv.slice(2);
diff --git a/scripts/merge.js b/scripts/merge.js
index 9efe3d4a91eb4ad7e29f1ae5c324f4590a98da65..c6dad2c52b09af228b2336a609318b64c6b8b40d 100644
--- a/scripts/merge.js
+++ b/scripts/merge.js
@@ -14,31 +14,6 @@ const REPO_DOCS_DIR = path.join(process.cwd(), '../../docs');
// 定义老版本 docs 仓库路径
const REPO_DOCS_CENTRALIZED_DIR = path.join(process.cwd(), '../../docs-centralized');
-// 定义build文件夹路径
-const BUILD_DIR = path.join(process.cwd(), '../../../build');
-
-// 删除build文件夹（如果存在）
-const deleteBuildDir = (BUILD_DIR) => {
- try {
- if (fs.existsSync(BUILD_DIR)) {
- fs.rmSync(BUILD_DIR, { recursive: true, force: true });
- }
- } catch (error) {
- console.error(`删除 ${BUILD_DIR} 文件夹时出错: ${error.message}`);
- process.exit(1);
- }
-};
-
-// 创建 build 文件夹
-const createBuildDir = (BUILD_DIR) => {
- try {
- fs.mkdirSync(BUILD_DIR, { recursive: true });
- } catch (error) {
- console.error(`创建 ${BUILD_DIR} 文件夹时出错: ${error.message}`);
- process.exit(1);
- }
-};
-
// 检查是否是git仓库
const checkGitRepo = (repoPath) => {
return new Promise((resolve, reject) => {
@@ -70,7 +45,7 @@ function replaceOrgDomain(targetPath) {
return;
}
- if (!name.endsWith('js') && !name.endsWith('html') && !name.endsWith('toml')) {
+ if (!name.endsWith('js') && !name.endsWith('html') && !name.endsWith('toml') && !name.endsWith('md')) {
return;
}
@@ -108,21 +83,15 @@ function replaceCommonNginxRedirect(branchName) {
oldUrl = oldUrl?.trim();
newUrl = newUrl?.trim();
if (oldUrl && newUrl && oldUrl !== newUrl && oldUrl.split('/')[3] === branchName) {
- oldUrl = oldUrl.replace(/([.*+?^${}()|[\]\\])/g, "\\$1").replace(/ /g, '\\s');
+ oldUrl = oldUrl.replace(/([.*+?^${}()|[\]\\])/g, '\\$1').replace(/ /g, '\\s');
rewrites.push(`rewrite ^${oldUrl}$ ${newUrl} permanent;\n `);
}
i++;
}
- if (rewrites.length > 0) {
- const nginxContent = fs.readFileSync(path.join(BUILD_DIR, 'deploy/nginx/nginx.conf'), 'utf8').replace('#[rewrite_template]', rewrites.join(''));
- console.log(nginxContent);
- fs.writeFileSync(path.join(BUILD_DIR, 'deploy/nginx/nginx.conf'), nginxContent, 'utf8');
- } else {
- fs.writeFileSync(path.join(BUILD_DIR, 'deploy/nginx/nginx.conf'), nginxContent.replace('#[rewrite_template]', ''), 'utf8');
- }
-
+ const nginxContent = fs.readFileSync(path.join(buildPath, 'deploy/nginx/nginx.conf'), 'utf8');
+ fs.writeFileSync(path.join(buildPath, 'deploy/nginx/nginx.conf'), nginxContent.replace('#[rewrite_template]', rewrites.join('')), 'utf8');
console.log(`替换nginx转发成功`);
} catch (err) {
console.log(`替换nginx转发内容失败，错误原因：${err?.message}`);
@@ -207,17 +176,21 @@ const copyContentToDir = (originDir, destDir) => {
});
};
-// 处理新版本内容
-const normalizeContent = async (branch) => {
+/**
+ * 按新版本方式处理
+ * @param {string} buildPath build 目录
+ * @param {string} branch 分支
+ */
+const normalizeContent = async (buildPath, branch) => {
const branchName = getBranchName(branch);
// 复制website-v2内容到build目录
- await copyContentToDir(path.join(REPO_DIR, 'website-v2'), BUILD_DIR);
+ await copyContentToDir(path.join(REPO_DIR, 'website-v2'), buildPath);
if (branchName == `common`) {
// 如果是公共分支，删掉nginx.conf并将nginx.portal.conf重命名为nginx.conf
- const nginxConfPath = path.join(BUILD_DIR, 'deploy/nginx/nginx.conf');
- const nginxPortalConfPath = path.join(BUILD_DIR, 'deploy/nginx/nginx.portal.conf');
+ const nginxConfPath = path.join(buildPath, 'deploy/nginx/nginx.conf');
+ const nginxPortalConfPath = path.join(buildPath, 'deploy/nginx/nginx.portal.conf');
if (fs.existsSync(nginxConfPath)) {
fs.rmSync(nginxConfPath);
console.log(`已删除 ${nginxConfPath}`);
@@ -228,33 +201,33 @@ const normalizeContent = async (branch) => {
}
} else {
// 如果是非公共分支，删除对应的nginx.portal.conf与中英文目录
- const nginxPortalConfPath = path.join(BUILD_DIR, 'deploy/nginx/nginx.portal.conf');
+ const nginxPortalConfPath = path.join(buildPath, 'deploy/nginx/nginx.portal.conf');
if (fs.existsSync(nginxPortalConfPath)) {
fs.rmSync(nginxPortalConfPath);
console.log(`已删除 ${nginxPortalConfPath}`);
}
- if (fs.existsSync(`${BUILD_DIR}/app/zh/`)) {
- fs.rmSync(`${BUILD_DIR}/app/zh/`, { recursive: true, force: true });
+ if (fs.existsSync(`${buildPath}/app/zh/`)) {
+ fs.rmSync(`${buildPath}/app/zh/`, { recursive: true, force: true });
}
- if (fs.existsSync(`${BUILD_DIR}/app/en/`)) {
- fs.rmSync(`${BUILD_DIR}/app/en/`, { recursive: true, force: true });
+ if (fs.existsSync(`${buildPath}/app/en/`)) {
+ fs.rmSync(`${buildPath}/app/en/`, { recursive: true, force: true });
}
}
- let vpConf = fs.readFileSync(`${BUILD_DIR}/app/.vitepress/config.ts`, 'utf8');
+ let vpConf = fs.readFileSync(`${buildPath}/app/.vitepress/config.ts`, 'utf8');
if (vpConf) {
vpConf = vpConf.replace(/assetsDir:\s*'[^']*'/, `assetsDir: '/assets/${branchName}/'`);
- fs.writeFileSync(`${BUILD_DIR}/app/.vitepress/config.ts`, vpConf, 'utf8');
+ fs.writeFileSync(`${buildPath}/app/.vitepress/config.ts`, vpConf, 'utf8');
}
- let packageJson = fs.readFileSync(`${BUILD_DIR}/package.json`, 'utf8');
+ let packageJson = fs.readFileSync(`${buildPath}/package.json`, 'utf8');
if (packageJson) {
packageJson = packageJson.replace('$VERSION', branchName);
- fs.writeFileSync(`${BUILD_DIR}/package.json`, packageJson, 'utf8');
+ fs.writeFileSync(`${buildPath}/package.json`, packageJson, 'utf8');
}
// 检出文档内容分支
@@ -263,18 +236,18 @@ const normalizeContent = async (branch) => {
// 只有存在 zh 内容并且是新版本内容才进行复制
if (fs.existsSync(`${REPO_DOCS_DIR}/docs/zh/`) && (fs.existsSync(`${REPO_DOCS_DIR}/docs/zh/_toc.yaml`) || branchName === 'common')) {
- fs.mkdirSync(`${BUILD_DIR}/app/zh/docs/${branchName}/`, {
+ fs.mkdirSync(`${buildPath}/app/zh/docs/${branchName}/`, {
recursive: true,
});
- await copyContentToDir(`${REPO_DOCS_DIR}/docs/zh/`, `${BUILD_DIR}/app/zh/docs/${branchName}/`);
+ await copyContentToDir(`${REPO_DOCS_DIR}/docs/zh/`, `${buildPath}/app/zh/docs/${branchName}/`);
}
// 只有存在 en 内容并且是新版本内容才进行复制
if (fs.existsSync(`${REPO_DOCS_DIR}/docs/en/`) && (fs.existsSync(`${REPO_DOCS_DIR}/docs/en/_toc.yaml`) || branchName === 'common')) {
- fs.mkdirSync(`${BUILD_DIR}/app/en/docs/${branchName}/`, {
+ fs.mkdirSync(`${buildPath}/app/en/docs/${branchName}/`, {
recursive: true,
});
- await copyContentToDir(`${REPO_DOCS_DIR}/docs/en/`, `${BUILD_DIR}/app/en/docs/${branchName}/`);
+ await copyContentToDir(`${REPO_DOCS_DIR}/docs/en/`, `${buildPath}/app/en/docs/${branchName}/`);
}
// 复制配置
@@ -284,11 +257,11 @@ const normalizeContent = async (branch) => {
}
if (fs.existsSync(`${REPO_DOCS_DIR}/dsl/`)) {
- fs.mkdirSync(`${BUILD_DIR}/app/.vitepress/public/dsl/`, {
+ fs.mkdirSync(`${buildPath}/app/.vitepress/public/dsl/`, {
recursive: true,
});
- await copyContentToDir(`${REPO_DOCS_DIR}/dsl/`, `${BUILD_DIR}/app/.vitepress/public/dsl/`);
+ await copyContentToDir(`${REPO_DOCS_DIR}/dsl/`, `${buildPath}/app/.vitepress/public/dsl/`);
console.log(`已将 dsl 复制到 public 目录下`);
}
@@ -298,18 +271,23 @@ const normalizeContent = async (branch) => {
}
};
-// 处理老版本内容
-const normalizeContentWithHugo = async (branch, source) => {
+/**
+ * 按旧版本方式处理
+ * @param {string} buildPath build 目录
+ * @param {string} branch 分支
+ * @param {string} source 启动来源
+ */
+const normalizeContentWithHugo = async (buildPath, branch, source) => {
const branchName = getBranchName(branch);
// 复制website内容到build目录
- await copyContentToDir(path.join(REPO_DIR, 'website'), BUILD_DIR);
+ await copyContentToDir(path.join(REPO_DIR, 'website'), buildPath);
- let hugoConf = fs.readFileSync(`${BUILD_DIR}/config.toml`, 'utf8');
+ let hugoConf = fs.readFileSync(`${buildPath}/config.toml`, 'utf8');
if (hugoConf) {
hugoConf = hugoConf.replace(/resourceURL\s*=\s*(["'])(.*?)\1/, `resourceURL = "/docs/${branchName}/"`);
- fs.writeFileSync(`${BUILD_DIR}/config.toml`, hugoConf, 'utf8');
+ fs.writeFileSync(`${buildPath}/config.toml`, hugoConf, 'utf8');
}
// 检出文档内容分支
@@ -317,36 +295,51 @@ const normalizeContentWithHugo = async (branch, source) => {
await pullRemoteBranch(REPO_DOCS_CENTRALIZED_DIR, branch);
if (fs.existsSync(`${REPO_DOCS_CENTRALIZED_DIR}/docs/zh/`)) {
- fs.mkdirSync(`${BUILD_DIR}/content/zh/docs/${branchName}/`, {
+ fs.mkdirSync(`${buildPath}/content/zh/docs/${branchName}/`, {
recursive: true,
});
- await copyContentToDir(`${REPO_DOCS_CENTRALIZED_DIR}/docs/zh/`, `${BUILD_DIR}/content/zh/docs/${branchName}/`);
+ await copyContentToDir(`${REPO_DOCS_CENTRALIZED_DIR}/docs/zh/`, `${buildPath}/content/zh/docs/${branchName}/`);
}
if (fs.existsSync(`${REPO_DOCS_CENTRALIZED_DIR}/docs/en/`)) {
- fs.mkdirSync(`${BUILD_DIR}/content/en/docs/${branchName}/`, {
+ fs.mkdirSync(`${buildPath}/content/en/docs/${branchName}/`, {
recursive: true,
});
- await copyContentToDir(`${REPO_DOCS_CENTRALIZED_DIR}/docs/en/`, `${BUILD_DIR}/content/en/docs/${branchName}/`);
+ await copyContentToDir(`${REPO_DOCS_CENTRALIZED_DIR}/docs/en/`, `${buildPath}/content/en/docs/${branchName}/`);
}
if (source === 'openatom') {
- replaceOrgDomain(path.join(BUILD_DIR, 'i18n'));
- replaceOrgDomain(path.join(BUILD_DIR, 'layouts'));
- replaceOrgDomain(path.join(BUILD_DIR, 'static'));
+ replaceOrgDomain(path.join(buildPath, 'i18n'));
+ replaceOrgDomain(path.join(buildPath, 'layouts'));
+ replaceOrgDomain(path.join(buildPath, 'static'));
+ replaceOrgDomain(path.join(buildPath, 'content'));
}
};
+/**
+ * 合并处理内容
+ * @param {string} branch 构建分支
+ * @param {string} source 启动来源
+ */
const merge = async (branch, source) => {
- deleteBuildDir(BUILD_DIR);
- createBuildDir(BUILD_DIR);
+ const buildPath = path.join(process.cwd(), `../../../build/${branch}`);
+
+ // 删除 build 目录
+ if (fs.existsSync(buildPath)) {
+ fs.rmSync(buildPath, { recursive: true, force: true });
+ }
+
+ // 创建 build 目录
+ fs.mkdirSync(buildPath, { recursive: true });
+
+ // 处理内容
try {
if (NEW_VERSONS.includes(branch)) {
await checkGitRepo(REPO_DOCS_DIR);
- await normalizeContent(branch);
+ await normalizeContent(buildPath, branch);
} else {
await checkGitRepo(REPO_DOCS_CENTRALIZED_DIR);
- await normalizeContentWithHugo(branch, source);
+ await normalizeContentWithHugo(buildPath, branch, source);
}
} catch (error) {
console.error(error.message);
@@ -354,6 +347,7 @@ const merge = async (branch, source) => {
}
};
+/*---------- 执行脚本 ----------*/
const args = process.argv.slice(2);
if (args.length === 0) {
console.error('请提供分支名称');
diff --git a/scripts/pre-dev.js b/scripts/pre-dev.js
index 8d87b580f2c3ee4539238305676406e88ad68ce7..53966c6390f2b31266a01b317a1f4b44f0efd014 100644
--- a/scripts/pre-dev.js
+++ b/scripts/pre-dev.js
@@ -38,6 +38,7 @@ function gitCloneAndCheckout(url, branch) {
console.log(`[pre-dev]: 本地存在分支 ${branch}，开始切换分支`);
try {
+ execSync(`cd ${repoDir} && git checkout HEAD -- . && git clean -fd`, { stdio: 'inherit' });
execSync(`cd ${repoDir} && git checkout ${branch}`, { stdio: 'inherit' });
console.log(`[pre-dev]: 切换分支成功，开始拉取远程更新内容`);
execSync(`cd ${repoDir} && git pull origin ${branch}`, { stdio: 'inherit' });
@@ -124,14 +125,18 @@ function copyDslContent() {
/**
* 复制 sig 仓库内容到指定位置
*/
-const copySigRepo = async (upstream, dir, storagePath) => {
+function copySigRepo(upstream, dir, storagePath) {
const { url, repo, branch, locations } = getGitUrlInfo(upstream);
- gitCloneAndCheckout(url, branch);
- const cachePath = path.join(CACHE_DIR, repo);
- const sourceDir = path.join(cachePath, ...locations.slice(0, -1));
- const destDir = storagePath ? path.join(dir, storagePath) : path.join(dir, repo, ...locations.slice(2, -1));
- copyDirectorySync(sourceDir, destDir);
- console.log(`[pre-dev]: 复制 ${sourceDir} 到 ${destDir}`);
+ try {
+ gitCloneAndCheckout(url, branch);
+ const cachePath = path.join(CACHE_DIR, repo);
+ const sourceDir = path.join(cachePath, ...locations.slice(0, -1));
+ const destDir = storagePath ? path.join(dir, storagePath) : path.join(dir, repo, ...locations.slice(2, -1));
+ copyDirectorySync(sourceDir, destDir);
+ console.log(`[pre-dev]: 复制 ${sourceDir} 到 ${destDir}`);
+ } catch (err) {
+ console.log(`[pre-dev]: 错误：${err?.message}，远程地址：${upstream}`);
+ }
};
/**
@@ -175,15 +180,22 @@ function scanYamlToCloneSigRepo(targetPath) {
}
}
-const syncDocs = async (branch) => {
+/**
+ * 同步文档内容到对应的目录
+ * @param {string} branch 分支名
+ */
+function syncDocs(branch) {
const branchName = getBranchName(branch);
- // 复制文档内容
gitCloneAndCheckout('https://gitee.com/openeuler/docs.git', branch);
copyDocsContent(branchName);
scanYamlToCloneSigRepo(`${__dirname}/app/zh/docs/${branchName}`);
scanYamlToCloneSigRepo(`${__dirname}/app/en/docs/${branchName}`);
+};
- // 复制 dsl 内容
+/**
+ * 同步 dsl 内容
+ */
+function syncDsl() {
gitCloneAndCheckout('https://gitee.com/openeuler/docs.git', 'stable-common');
copyDslContent();
};
@@ -192,6 +204,9 @@ const args = process.argv.slice(2);
if (args.length === 0) {
console.error('请提供分支名称');
process.exit(1);
-} else {
- syncDocs(args[0]);
+}
+
+syncDsl();
+for (const branch of args) {
+ syncDocs(branch);
}
diff --git a/scripts/utils/common.js b/scripts/utils/common.js
index 009d628814a1279c7380d7fbae3ed1da7b5c6d03..ea7fe92a5b92bb016bc47e86fb28e3a6f9e91dac 100644
--- a/scripts/utils/common.js
+++ b/scripts/utils/common.js
@@ -3,5 +3,5 @@
* @param {string} branch 原始分支名
*/
export function getBranchName(branch) {
- return branch.replace(/^stable-|^test-/, '');
+ return branch.replace(/^stable2-|stable-|^test-/, '');
}
diff --git a/tsconfig.node.json b/tsconfig.node.json
index c21af264d944dac87d8fc4b89d1b0076b66c03b4..3fa78be22876337688f7c0e1bb55f9c4778b1a33 100644
--- a/tsconfig.node.json
+++ b/tsconfig.node.json
@@ -1,12 +1,21 @@
{
"extends": "@tsconfig/node18/tsconfig.json",
- "include": ["app/vite.config.*", "vitest.config.*", "cypress.config.*", "nightwatch.conf.*", "playwright.config.*"],
+ "include": [
+ "app/vite.config.*",
+ "app/.vitepress/plugins/*",
+ "vitest.config.*",
+ "cypress.config.*",
+ "nightwatch.conf.*",
+ "playwright.config.*"
+ ],
"compilerOptions": {
"composite": true,
"noEmit": true,
"tsBuildInfoFile": "./node_modules/.tmp/tsconfig.node.tsbuildinfo",
"module": "ESNext",
"moduleResolution": "Bundler",
- "types": ["node"]
+ "types": [
+ "node"
+ ]
}
-}
+}
\ No newline at end of file