From f1bab28732d3610e5489a736e77abddf487754af Mon Sep 17 00:00:00 2001 From: luckyasme <807254037@qq.com> Date: Mon, 30 Jun 2025 14:09:46 +0800 Subject: [PATCH 1/2] =?UTF-8?q?feat:=20=E6=96=B0=E8=80=81=E7=89=88?= =?UTF-8?q?=E6=9C=AC=E4=BB=93=E5=BA=93=E5=88=87=E6=8D=A2=E6=9E=84=E5=BB=BA?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .gitignore | 4 +- app/.vitepress/src/@types/type-doc-menu.ts | 2 + app/.vitepress/src/api/api-common.ts | 15 + app/.vitepress/src/api/api-feedback.ts | 6 +- app/.vitepress/src/api/api-user.ts | 2 +- .../src/assets/style/theme/message.scss | 2 +- app/.vitepress/src/components/AppFooter.vue | 4 +- .../src/components/CookieNotice.vue | 2 +- .../src/components/FloatingButtonDocs.vue | 9 +- .../src/components/GiteeViewSource.vue | 13 +- .../src/components/doc/DocBugDialog.vue | 48 +- app/.vitepress/src/components/doc/DocMenu.vue | 22 +- .../src/components/doc/DocSearch.vue | 4 +- app/.vitepress/src/components/doc/DocType.vue | 62 +- .../src/components/doc/DocTypeMobile.vue | 55 +- .../src/components/doc/DocVersion.vue | 35 +- .../src/components/doc/DocVersionMobile.vue | 47 +- .../components/feedback/FeedbackSlider.vue | 4 +- .../src/components/header/AppHeader.vue | 3 +- .../src/components/header/HeaderLanguage.vue | 22 +- .../src/components/header/HeaderLogin.vue | 4 +- .../src/components/header/HeaderNav.vue | 2 +- .../src/components/header/HeaderNavMoblie.vue | 4 +- .../src/components/header/HeaderTheme.vue | 11 +- .../src/components/header/NavContent.vue | 2 + .../src/components/header/NavLink.vue | 3 - .../src/components/markdown/MarkdownTitle.vue | 2 +- .../src/components/menu/RecursionMenuItem.vue | 17 +- .../src/composables/useClipboard.ts | 15 +- app/.vitepress/src/config/dsl.ts | 4 +- app/.vitepress/src/config/menu.ts | 7 - app/.vitepress/src/config/toc.ts | 7 + app/.vitepress/src/config/version.ts | 268 ++++++-- app/.vitepress/src/layouts/LayoutDoc.vue | 40 +- .../src/shared/analytics/directives.ts | 4 +- app/.vitepress/src/shared/analytics/setup.ts | 3 +- app/.vitepress/src/shared/login.ts | 2 +- app/.vitepress/src/stores/node.ts | 4 +- app/.vitepress/src/utils/common.ts | 40 +- app/.vitepress/src/utils/scroll-to.ts | 6 +- app/.vitepress/src/utils/tree.ts | 8 +- app/.vitepress/src/views/docs/TheDocsNode.vue | 2 +- app/.vitepress/src/views/home/TheHome.vue | 4 +- deploy/nginx/nginx.conf | 3 + deploy/nginx/nginx.portal.conf | 36 +- eslint.config.js | 32 + package.json | 11 +- pnpm-lock.yaml | 645 +++++++++++------- scripts/config/new-version.js | 1 + scripts/gen-toc.js | 102 +-- scripts/merge-upstream.js | 22 +- scripts/merge.js | 89 ++- scripts/pre-build-check.js | 135 ---- scripts/pre-dev.js | 190 +++++- scripts/utils/common.js | 7 + 55 files changed, 1394 insertions(+), 699 deletions(-) create mode 100644 app/.vitepress/src/api/api-common.ts delete mode 100644 app/.vitepress/src/config/menu.ts create mode 100644 app/.vitepress/src/config/toc.ts create mode 100644 eslint.config.js create mode 100644 scripts/config/new-version.js delete mode 100644 scripts/pre-build-check.js create mode 100644 scripts/utils/common.js diff --git a/.gitignore b/.gitignore index 83563d75f..e59aab703 100644 --- a/.gitignore +++ b/.gitignore @@ -119,6 +119,7 @@ dist .DS_Store temp-docs +.cache app/zh/docs/**/* app/en/docs/**/* @@ -128,6 +129,7 @@ app/.vitepress/.cache app/.vitepress/dist app/.vitepress/cache app/.vitepress/public/menu/**/* +app/.vitepress/public/toc/**/* app/.vitepress/public/dsl/**/* -.env.development \ No newline at end of file +.env.development diff --git a/app/.vitepress/src/@types/type-doc-menu.ts b/app/.vitepress/src/@types/type-doc-menu.ts index 6ca938ee8..a33b24f80 100644 --- a/app/.vitepress/src/@types/type-doc-menu.ts +++ b/app/.vitepress/src/@types/type-doc-menu.ts @@ -5,5 +5,7 @@ export interface DocMenuT { description?: string; type: string; isManual?: boolean; + upstream?: string; + path?: string; sections?: Array; } diff --git a/app/.vitepress/src/api/api-common.ts b/app/.vitepress/src/api/api-common.ts new file mode 100644 index 000000000..b8461a60c --- /dev/null +++ b/app/.vitepress/src/api/api-common.ts @@ -0,0 +1,15 @@ +import { request } from '@/shared/axios'; + +/** + * 检测页面是否存在 + * @param {string} path string + * @return {boolean} + */ +export async function isPageExist(path: string) { + try { + await request.head(path, { showError: false }); + return true; + } catch { + return false; + } +} \ No newline at end of file diff --git a/app/.vitepress/src/api/api-feedback.ts b/app/.vitepress/src/api/api-feedback.ts index 674ca0a5c..946b7feaa 100644 --- a/app/.vitepress/src/api/api-feedback.ts +++ b/app/.vitepress/src/api/api-feedback.ts @@ -29,7 +29,7 @@ export function postFeedback(params: FeedBackQueryT): Promise<{ update_at: string; }> { const url = '/api-dsapi/query/nps?community=openeuler'; - return request.post(url, params).then((res: AxiosResponse) => res.data); + return request.post(url, params, { showError: false }).then((res: AxiosResponse) => res.data); } /** @@ -44,7 +44,7 @@ export function postArticleFeedback(params: FeedBackDataT): Promise<{ update_at: string; }> { const url = '/api-dsapi/query/doc/nps/openeuler'; - return request.post(url, params).then((res: AxiosResponse) => res.data); + return request.post(url, params, { showError: false }).then((res: AxiosResponse) => res.data); } /** @@ -55,7 +55,7 @@ export function postArticleFeedback(params: FeedBackDataT): Promise<{ */ export function submitDocsBug(lang: string, params: DocsBugParamsT) { const url = `/api-dsapi/query/add/bugquestionnaire?community=openeuler&lang=${lang}`; - return request.post(url, params).then((res) => { + return request.post(url, params, { showError: false }).then((res) => { return res.data; }); } diff --git a/app/.vitepress/src/api/api-user.ts b/app/.vitepress/src/api/api-user.ts index ca328fc23..7c25fc3c4 100644 --- a/app/.vitepress/src/api/api-user.ts +++ b/app/.vitepress/src/api/api-user.ts @@ -14,5 +14,5 @@ interface UserPermissionResponseT { */ export function queryUserInfo() { const url = '/api-id/oneid/personal/center/user?community=openeuler'; - return request.get(url).then((res) => res.data.data); + return request.get(url, { showError: false }).then((res) => res.data.data); } diff --git a/app/.vitepress/src/assets/style/theme/message.scss b/app/.vitepress/src/assets/style/theme/message.scss index fe6ba2c2c..6d52e02d3 100644 --- a/app/.vitepress/src/assets/style/theme/message.scss +++ b/app/.vitepress/src/assets/style/theme/message.scss @@ -1,5 +1,5 @@ .o-message-list { - z-index: 1008; + z-index: 2147483647 !important; --app-header-height: 64px; --app-footer-height: 300px; diff --git a/app/.vitepress/src/components/AppFooter.vue b/app/.vitepress/src/components/AppFooter.vue index 68e26dceb..4007380a2 100644 --- a/app/.vitepress/src/components/AppFooter.vue +++ b/app/.vitepress/src/components/AppFooter.vue @@ -68,12 +68,12 @@ const baseUrl = import.meta.env.VITE_MAIN_DOMAIN_URL;
-
+
{{ category.title }}
diff --git a/app/.vitepress/src/components/CookieNotice.vue b/app/.vitepress/src/components/CookieNotice.vue index c8b07ca1c..02a1d49e2 100644 --- a/app/.vitepress/src/components/CookieNotice.vue +++ b/app/.vitepress/src/components/CookieNotice.vue @@ -133,7 +133,7 @@ const dlgActions: Array = [ ]; // 弹窗框关闭 -const onDlgChange = (val: boolean) => { +const onDlgChange = () => { // 关闭时 if (!isAllAgreed()) { setTimeout(() => { diff --git a/app/.vitepress/src/components/FloatingButtonDocs.vue b/app/.vitepress/src/components/FloatingButtonDocs.vue index dd4e00cfe..61f6f1fed 100644 --- a/app/.vitepress/src/components/FloatingButtonDocs.vue +++ b/app/.vitepress/src/components/FloatingButtonDocs.vue @@ -40,7 +40,6 @@ const docBugVisible = ref(false); const scoreRef = ref(); const showPopup = ref(false); // 显示评分详细 -const currentScore = ref(0); // 当前评分 // 鼠标进入图标区域 const onMouseEnter = () => { @@ -120,7 +119,7 @@ const marks: Marks = Array(RATE_MAX + 1) return acc; }, Object.create(null)); -const updateItemScore = (value: number, index: number) => { +const updateItemScore = () => { showPopup.value = true; }; @@ -257,13 +256,13 @@ const submitArticleFeedback = () => { showPopup.value = false; cancelScore(); } else { - message.warning({ + message.danger({ content: t('feedback.feedbackSubmitFailed'), }); } }) .catch(() => { - message.warning({ + message.danger({ content: t('feedback.feedbackSubmitFailed'), }); }); @@ -312,7 +311,7 @@ const submitArticleFeedback = () => { show-stops :show-tooltip="true" tooltip-class="doc-item-tooltip" - @input="updateItemScore(item.value, i)" + @input="updateItemScore" @change="updateItemScoreAfter(i)" /> diff --git a/app/.vitepress/src/components/GiteeViewSource.vue b/app/.vitepress/src/components/GiteeViewSource.vue index e262d04b9..a6f70fd6d 100644 --- a/app/.vitepress/src/components/GiteeViewSource.vue +++ b/app/.vitepress/src/components/GiteeViewSource.vue @@ -9,22 +9,25 @@ import { getGiteeUrl } from '@/utils/common'; import { useScreen } from '@/composables/useScreen'; import { useLocale } from '@/composables/useLocale'; +import { useNodeStore } from '@/stores/node'; const { t } = useLocale(); -const giteeUrl = ref(''); const route = useRoute(); +const nodeStore = useNodeStore(); + +const giteeUrl = ref(''); watch( () => route.path, () => { if (isClient) { - giteeUrl.value = getGiteeUrl(); + giteeUrl.value = getGiteeUrl(nodeStore.pageNode); } } ); onMounted(() => { - giteeUrl.value = getGiteeUrl(); + giteeUrl.value = getGiteeUrl(nodeStore.pageNode); }); // -------------------- 移动端插入gitee -------------------- @@ -34,7 +37,7 @@ const insertGiteeBtn = () => { if (isPhone.value) { const link = document.querySelector('.markdown-body .gitee') as HTMLAnchorElement; if (link) { - link.href = getGiteeUrl(); + link.href = getGiteeUrl(nodeStore.pageNode); return; } @@ -45,7 +48,7 @@ const insertGiteeBtn = () => { container.className = 'article-detail-container'; const a = document.createElement('a'); a.className = 'gitee'; - a.href = getGiteeUrl(); + a.href = getGiteeUrl(nodeStore.pageNode); a.target = '_blank'; a.textContent = t('docs.viewGiteeSource') || ''; const svgString = ` diff --git a/app/.vitepress/src/components/doc/DocBugDialog.vue b/app/.vitepress/src/components/doc/DocBugDialog.vue index 44a6d4323..bb76d70b8 100644 --- a/app/.vitepress/src/components/doc/DocBugDialog.vue +++ b/app/.vitepress/src/components/doc/DocBugDialog.vue @@ -5,10 +5,7 @@ import { OForm, OFormItem, type RulesT, - type ValidatorT, type FieldResultT, - OIcon, - OInput, OTextarea, OButton, ORadioGroup, @@ -27,11 +24,15 @@ import { submitDocsBug } from '@/api/api-feedback'; import { useLocale } from '@/composables/useLocale'; import { oaReport } from '@/shared/analytics'; +import { useNodeStore } from '@/stores/node'; +import { useViewStore } from '@/stores/view'; const VITE_MAIN_DOMAIN_URL = import.meta.env.VITE_MAIN_DOMAIN_URL; const message = useMessage(); const { t, locale } = useLocale(); const { page } = useData(); +const viewStore = useViewStore(); +const nodeStore = useNodeStore(); const props = defineProps({ modelValue: { @@ -68,14 +69,6 @@ const descriptionRules = reactive([ triggers: ['blur'], }, ]); -// -------------------- 联系方式验证 -------------------- -const emailRules = reactive([ - { - required: true, - message: '', - triggers: ['blur'], - }, -]); // -------------------- 提交类型 -------------------- const submitType = ref('issue'); @@ -148,8 +141,11 @@ const isAgree = ref<(string | number)[]>([]); const onAgree = () => {}; const issueTemplate = (data: DocsBugParamsT) => { - let Problem = ''; - data.existProblem.length == 0 ? '' : (Problem = `- ${data.existProblem.join('、')}`); + let problem = ''; + if (data.existProblem.length == 0) { + problem = `- ${data.existProblem.join('、')}`; + } + return `1. 【文档链接】 > ${data.link} @@ -160,7 +156,7 @@ const issueTemplate = (data: DocsBugParamsT) => { 3. 【存在的问题】 - ${Problem} + ${problem} > ${data.problemDetail.replace(/(\r\n|\r|\n)+/g, '$1')} 4. 【预期结果】 @@ -188,11 +184,8 @@ const submitBug = (results: FieldResultT[]) => { if (res.code === 200) { emit('update:modelValue', false); if (submitType.value === 'issue') { - window.open( - window.location.pathname.includes('/openstack/') - ? `https://gitee.com/openeuler/openstack-docs/issues/new?issue%5Bassignee_id%5D=0&issue%5Bmilestone_id%5D=0&title=文档捉虫&description=${body}` - : `https://gitee.com/openeuler/docs-centralized/issues/new?issue%5Bassignee_id%5D=0&issue%5Bmilestone_id%5D=0&title=文档捉虫&description=${body}` - ); + const issueBaseUrl = nodeStore.pageNode?.upstream ? nodeStore.pageNode.upstream.split('/blob')[0] : 'https://gitee.com/openeuler/docs'; + window.open(`${issueBaseUrl}/issues/new?issue%5Bassignee_id%5D=0&issue%5Bmilestone_id%5D=0&title=文档捉虫&description=${body}`); } else { let pathname = window.location.pathname; if (pathname.endsWith('.html')) { @@ -204,16 +197,21 @@ const submitBug = (results: FieldResultT[]) => { } const [_, lang, __, branch, ...others] = pathname.split('/'); - window.open( - pathname.includes('/openstack/') - ? `https://gitee.com/-/ide/project/openeuler/openstack-docs/edit/openEuler-${branch}/-/docs/${lang}/${others.slice(3).join('/')}?search=${first}&title=文档捉虫-openEuler ${branch}-${page.value.title}&description=${formData.description}&message=${formData.description}&label_names=文档捉虫` - : `https://gitee.com/-/ide/project/openeuler/docs/edit/${branch}/-/docs/${lang}/${others.join('/')}?search=${first}&title=文档捉虫-openEuler ${branch}-${page.value.title}&description=${formData.description}&message=${formData.description}&label_names=文档捉虫` - ); + if (viewStore.isOverview && nodeStore.pageNode?.href) { + const arr = nodeStore.pageNode.href.replace('index.html', '_toc.yaml').split('/'); + window.open(`https://gitee.com/-/ide/project/openeuler/docs/edit/stable-${arr[3]}/-/docs/${lang}/${arr.slice(4).join('/')}?search=${first}&title=文档捉虫-openEuler ${branch}-${page.value.title}&description=${formData.description}&message=${formData.description}&label_names=文档捉虫`); + } else if (nodeStore.pageNode?.upstream) { + const arr = nodeStore.pageNode.upstream.split('/'); + window.open(`https://gitee.com/-/ide/project/${arr[3]}/${arr[4]}/edit/${arr[6]}/-/${arr.slice(7).join('/')}?search=${first}&title=文档捉虫-openEuler ${branch}-${page.value.title}&description=${formData.description}&message=${formData.description}&label_names=文档捉虫`); + } else { + window.open(`https://gitee.com/-/ide/project/openeuler/docs/edit/stable-${branch}/-/docs/${lang}/${others.join('/')}?search=${first}&title=文档捉虫-openEuler ${branch}-${page.value.title}&description=${formData.description}&message=${formData.description}&label_names=文档捉虫`); + } + } } }) .catch(() => { - message.warning({ + message.danger({ content: t('feedback.feedbackFailed'), }); }); diff --git a/app/.vitepress/src/components/doc/DocMenu.vue b/app/.vitepress/src/components/doc/DocMenu.vue index 61f106a1b..7d75974f3 100644 --- a/app/.vitepress/src/components/doc/DocMenu.vue +++ b/app/.vitepress/src/components/doc/DocMenu.vue @@ -62,14 +62,18 @@ const expanded = useVModel(props, 'expanded', emits); @@ -93,7 +97,7 @@ const expanded = useVModel(props, 'expanded', emits);