From 11ce2139d4020919366b4567a08caece994760cd Mon Sep 17 00:00:00 2001 From: Pesar Date: Thu, 21 Dec 2023 13:16:46 +0330 Subject: [PATCH 1/2] docs(fa): start Persian docs --- packages/docs/.vitepress/config/fa.ts | 189 +++++++ packages/docs/.vitepress/config/index.ts | 2 + .../theme/components/HomeSponsors.vue | 1 + .../theme/components/HomeSponsorsGroup.vue | 2 +- .../fa/api/enums/NavigationFailureType.md | 37 ++ packages/docs/fa/api/index.md | 423 ++++++++++++++++ .../docs/fa/api/interfaces/HistoryState.md | 13 + .../fa/api/interfaces/NavigationFailure.md | 79 +++ .../docs/fa/api/interfaces/NavigationGuard.md | 28 ++ .../fa/api/interfaces/NavigationGuardNext.md | 73 +++ .../api/interfaces/NavigationGuardWithThis.md | 35 ++ .../fa/api/interfaces/NavigationHookAfter.md | 25 + .../docs/fa/api/interfaces/RouteLocation.md | 123 +++++ .../fa/api/interfaces/RouteLocationMatched.md | 147 ++++++ .../api/interfaces/RouteLocationNormalized.md | 122 +++++ .../RouteLocationNormalizedLoaded.md | 124 +++++ .../fa/api/interfaces/RouteLocationOptions.md | 37 ++ packages/docs/fa/api/interfaces/RouteMeta.md | 28 ++ .../docs/fa/api/interfaces/RouteRecordBase.md | 149 ++++++ .../interfaces/RouteRecordMultipleViews.md | 187 +++++++ .../RouteRecordMultipleViewsWithChildren.md | 187 +++++++ .../api/interfaces/RouteRecordNormalized.md | 107 ++++ .../fa/api/interfaces/RouteRecordRedirect.md | 184 +++++++ .../api/interfaces/RouteRecordSingleView.md | 185 +++++++ .../RouteRecordSingleViewWithChildren.md | 185 +++++++ packages/docs/fa/api/interfaces/Router.md | 421 ++++++++++++++++ .../docs/fa/api/interfaces/RouterHistory.md | 168 +++++++ .../docs/fa/api/interfaces/RouterLinkProps.md | 74 +++ .../docs/fa/api/interfaces/RouterOptions.md | 188 +++++++ .../fa/api/interfaces/RouterScrollBehavior.md | 27 + .../docs/fa/api/interfaces/RouterViewProps.md | 19 + .../docs/fa/guide/advanced/composition-api.md | 133 +++++ .../docs/fa/guide/advanced/data-fetching.md | 116 +++++ .../docs/fa/guide/advanced/dynamic-routing.md | 115 +++++ .../guide/advanced/extending-router-link.md | 94 ++++ .../docs/fa/guide/advanced/lazy-loading.md | 86 ++++ packages/docs/fa/guide/advanced/meta.md | 80 +++ .../fa/guide/advanced/navigation-failures.md | 110 +++++ .../fa/guide/advanced/navigation-guards.md | 282 +++++++++++ .../fa/guide/advanced/router-view-slot.md | 73 +++ .../docs/fa/guide/advanced/scroll-behavior.md | 115 +++++ .../docs/fa/guide/advanced/transitions.md | 84 ++++ .../docs/fa/guide/advanced/typed-routes.md | 10 + .../fa/guide/essentials/dynamic-matching.md | 125 +++++ .../docs/fa/guide/essentials/history-mode.md | 217 ++++++++ .../docs/fa/guide/essentials/named-routes.md | 43 ++ .../docs/fa/guide/essentials/named-views.md | 94 ++++ .../docs/fa/guide/essentials/navigation.md | 113 +++++ .../docs/fa/guide/essentials/nested-routes.md | 130 +++++ .../docs/fa/guide/essentials/passing-props.md | 97 ++++ .../fa/guide/essentials/redirect-and-alias.md | 113 +++++ .../guide/essentials/route-matching-syntax.md | 119 +++++ packages/docs/fa/guide/index.md | 101 ++++ packages/docs/fa/guide/migration/index.md | 462 ++++++++++++++++++ packages/docs/fa/index.md | 45 ++ packages/docs/fa/installation.md | 57 +++ packages/docs/fa/introduction.md | 27 + 57 files changed, 6609 insertions(+), 1 deletion(-) create mode 100644 packages/docs/.vitepress/config/fa.ts create mode 100644 packages/docs/fa/api/enums/NavigationFailureType.md create mode 100644 packages/docs/fa/api/index.md create mode 100644 packages/docs/fa/api/interfaces/HistoryState.md create mode 100644 packages/docs/fa/api/interfaces/NavigationFailure.md create mode 100644 packages/docs/fa/api/interfaces/NavigationGuard.md create mode 100644 packages/docs/fa/api/interfaces/NavigationGuardNext.md create mode 100644 packages/docs/fa/api/interfaces/NavigationGuardWithThis.md create mode 100644 packages/docs/fa/api/interfaces/NavigationHookAfter.md create mode 100644 packages/docs/fa/api/interfaces/RouteLocation.md create mode 100644 packages/docs/fa/api/interfaces/RouteLocationMatched.md create mode 100644 packages/docs/fa/api/interfaces/RouteLocationNormalized.md create mode 100644 packages/docs/fa/api/interfaces/RouteLocationNormalizedLoaded.md create mode 100644 packages/docs/fa/api/interfaces/RouteLocationOptions.md create mode 100644 packages/docs/fa/api/interfaces/RouteMeta.md create mode 100644 packages/docs/fa/api/interfaces/RouteRecordBase.md create mode 100644 packages/docs/fa/api/interfaces/RouteRecordMultipleViews.md create mode 100644 packages/docs/fa/api/interfaces/RouteRecordMultipleViewsWithChildren.md create mode 100644 packages/docs/fa/api/interfaces/RouteRecordNormalized.md create mode 100644 packages/docs/fa/api/interfaces/RouteRecordRedirect.md create mode 100644 packages/docs/fa/api/interfaces/RouteRecordSingleView.md create mode 100644 packages/docs/fa/api/interfaces/RouteRecordSingleViewWithChildren.md create mode 100644 packages/docs/fa/api/interfaces/Router.md create mode 100644 packages/docs/fa/api/interfaces/RouterHistory.md create mode 100644 packages/docs/fa/api/interfaces/RouterLinkProps.md create mode 100644 packages/docs/fa/api/interfaces/RouterOptions.md create mode 100644 packages/docs/fa/api/interfaces/RouterScrollBehavior.md create mode 100644 packages/docs/fa/api/interfaces/RouterViewProps.md create mode 100644 packages/docs/fa/guide/advanced/composition-api.md create mode 100644 packages/docs/fa/guide/advanced/data-fetching.md create mode 100644 packages/docs/fa/guide/advanced/dynamic-routing.md create mode 100644 packages/docs/fa/guide/advanced/extending-router-link.md create mode 100644 packages/docs/fa/guide/advanced/lazy-loading.md create mode 100644 packages/docs/fa/guide/advanced/meta.md create mode 100644 packages/docs/fa/guide/advanced/navigation-failures.md create mode 100644 packages/docs/fa/guide/advanced/navigation-guards.md create mode 100644 packages/docs/fa/guide/advanced/router-view-slot.md create mode 100644 packages/docs/fa/guide/advanced/scroll-behavior.md create mode 100644 packages/docs/fa/guide/advanced/transitions.md create mode 100644 packages/docs/fa/guide/advanced/typed-routes.md create mode 100644 packages/docs/fa/guide/essentials/dynamic-matching.md create mode 100644 packages/docs/fa/guide/essentials/history-mode.md create mode 100644 packages/docs/fa/guide/essentials/named-routes.md create mode 100644 packages/docs/fa/guide/essentials/named-views.md create mode 100644 packages/docs/fa/guide/essentials/navigation.md create mode 100644 packages/docs/fa/guide/essentials/nested-routes.md create mode 100644 packages/docs/fa/guide/essentials/passing-props.md create mode 100644 packages/docs/fa/guide/essentials/redirect-and-alias.md create mode 100644 packages/docs/fa/guide/essentials/route-matching-syntax.md create mode 100644 packages/docs/fa/guide/index.md create mode 100644 packages/docs/fa/guide/migration/index.md create mode 100644 packages/docs/fa/index.md create mode 100644 packages/docs/fa/installation.md create mode 100644 packages/docs/fa/introduction.md diff --git a/packages/docs/.vitepress/config/fa.ts b/packages/docs/.vitepress/config/fa.ts new file mode 100644 index 000000000..cc2e1498a --- /dev/null +++ b/packages/docs/.vitepress/config/fa.ts @@ -0,0 +1,189 @@ +import type { DefaultTheme, LocaleSpecificConfig } from 'vitepress' + +export const META_URL = 'https://router.vuejs.org' +export const META_TITLE = 'Vue Router' +export const META_DESCRIPTION = 'مسیریاب رسمی برای Vue.js' + +export const faConfig: LocaleSpecificConfig = { + description: META_DESCRIPTION, + head: [ + ['meta', { property: 'og:url', content: META_URL }], + ['meta', { property: 'og:description', content: META_DESCRIPTION }], + ['meta', { property: 'twitter:url', content: META_URL }], + ['meta', { property: 'twitter:title', content: META_TITLE }], + ['meta', { property: 'twitter:description', content: META_DESCRIPTION }], + ], + + themeConfig: { + editLink: { + pattern: 'https://github.com/vuejs/router/edit/main/packages/docs/:path', + text: 'پیشنهاد تغییرات در این صفحه', + }, + + nav: [ + // { text: 'Config', link: '/config/' }, + // { text: 'Plugins', link: '/plugins/' }, + { + text: 'راهنما', + link: '/fa/guide/', + activeMatch: '^/fa/guide/', + }, + { text: 'API', link: '/fa/api/', activeMatch: '^/fa/api/' }, + { + text: 'v4.x', + items: [{ text: 'v3.x', link: 'https://v3.router.vuejs.org/fa' }], + }, + { + text: 'پیوند‌ها', + items: [ + { + text: 'Discussions', + link: 'https://github.com/vuejs/router/discussions', + }, + { + text: 'Changelog', + link: 'https://github.com/vuejs/router/blob/main/packages/router/CHANGELOG.md', + }, + { + text: 'Vue.js Certification', + link: 'https://certification.vuejs.org/?friend=VUEROUTER', + }, + ], + }, + ], + + sidebar: { + // catch-all fallback + '/': [ + { + text: 'آغاز', + items: [ + { + text: 'معرفی', + link: '/fa/introduction.html', + }, + { + text: 'نصب', + link: '/fa/installation.html', + }, + ], + }, + { + text: 'الزامات', + collapsible: false, + items: [ + { + text: 'شروع شدن', + link: '/fa/guide/', + }, + { + text: 'تطبیق مسیر به صورت پویا', + link: '/fa/guide/essentials/dynamic-matching.html', + }, + { + text: 'نحو تطبیق مسیرها', + link: '/fa/guide/essentials/route-matching-syntax.html', + }, + { + text: 'مسیرهای تو در تو', + link: '/fa/guide/essentials/nested-routes.html', + }, + { + text: 'مسیریابی به صورت برنامه‌ای', + link: '/fa/guide/essentials/navigation.html', + }, + { + text: 'مسیرهای نام‌گذاری‌شده', + link: '/fa/guide/essentials/named-routes.html', + }, + { + text: 'View های نام‌گذاری‌شده', + link: '/fa/guide/essentials/named-views.html', + }, + { + text: 'ریدایرکت و مخفف', + link: '/fa/guide/essentials/redirect-and-alias.html', + }, + { + text: 'ارسال پراپ‌ها به کامپوننت مسیرها', + link: '/fa/guide/essentials/passing-props.html', + }, + { + text: 'حالت‌های متفاوت هیستوری', + link: '/fa/guide/essentials/history-mode.html', + }, + ], + }, + { + text: 'پیشرفته', + collapsible: false, + items: [ + { + text: 'گاردهای مسیریابی', + link: '/fa/guide/advanced/navigation-guards.html', + }, + { + text: 'فیلدهای متا', + link: '/fa/guide/advanced/meta.html', + }, + { + text: 'واکشی داده (Data Fetching)', + link: '/fa/guide/advanced/data-fetching.html', + }, + { + text: 'Composition API', + link: '/fa/guide/advanced/composition-api.html', + }, + { + text: 'RouterView اسلات', + link: '/fa/guide/advanced/router-view-slot.html', + }, + { + text: 'ترنزیشن‌ها', + link: '/fa/guide/advanced/transitions.html', + }, + { + text: 'رفتار اسکرول', + link: '/fa/guide/advanced/scroll-behavior.html', + }, + { + text: 'مسیرهای تنبل(Lazy Loading)', + link: '/fa/guide/advanced/lazy-loading.html', + }, + { + text: 'مسیرهای تایپ‌گذاری‌شده', + link: '/fa/guide/advanced/typed-routes.html', + }, + { + text: 'گسترش RouterLink', + link: '/fa/guide/advanced/extending-router-link.html', + }, + { + text: 'خطاهای Navigation', + link: '/fa/guide/advanced/navigation-failures.html', + }, + { + text: 'مسیریابی پویا', + link: '/fa/guide/advanced/dynamic-routing.html', + }, + ], + }, + { + items: [ + { + text: 'مهاجرت از Vue 2', + link: '/fa/guide/migration/index.html', + }, + ], + }, + ], + + '/fa/api/': [ + { + text: 'packages', + items: [{ text: 'vue-router', link: '/fa/api/' }], + }, + ], + }, + }, +} diff --git a/packages/docs/.vitepress/config/index.ts b/packages/docs/.vitepress/config/index.ts index 4b680a48c..8901c96b7 100644 --- a/packages/docs/.vitepress/config/index.ts +++ b/packages/docs/.vitepress/config/index.ts @@ -2,6 +2,7 @@ import { defineConfig } from 'vitepress' import { enConfig } from './en' import { sharedConfig } from './shared' import { zhConfig } from './zh' +import { faConfig } from './fa' export default defineConfig({ ...sharedConfig, @@ -12,5 +13,6 @@ export default defineConfig({ ko: { label: '한국어', lang: 'ko-KR', link: 'https://router.vuejs.kr/' }, pt: { label: 'Português', lang: 'pt-PT', link: 'https://vue-router-docs-pt.netlify.app/' }, ru: { label: 'Русский', lang: 'ru-RU', link: 'https://vue-router-ru.netlify.app' }, + fa: { label: 'فارسی', lang: 'fa-IR', link: '/fa/', ...faConfig }, }, }) diff --git a/packages/docs/.vitepress/theme/components/HomeSponsors.vue b/packages/docs/.vitepress/theme/components/HomeSponsors.vue index 458b02c7d..345fd624c 100644 --- a/packages/docs/.vitepress/theme/components/HomeSponsors.vue +++ b/packages/docs/.vitepress/theme/components/HomeSponsors.vue @@ -34,6 +34,7 @@ const translations = { en: 'Become a sponsor', 'en-US': 'Become a Sponsor!', 'zh-CN': '成为赞助者!', + 'fa-IR': 'حامی شوید!', } diff --git a/packages/docs/.vitepress/theme/components/HomeSponsorsGroup.vue b/packages/docs/.vitepress/theme/components/HomeSponsorsGroup.vue index 8e876c6f6..d8f60b60b 100644 --- a/packages/docs/.vitepress/theme/components/HomeSponsorsGroup.vue +++ b/packages/docs/.vitepress/theme/components/HomeSponsorsGroup.vue @@ -1,5 +1,5 @@