diff --git a/.github/.typo-ci.yml b/.github/.typo-ci.yml deleted file mode 100644 index be19c5046..000000000 --- a/.github/.typo-ci.yml +++ /dev/null @@ -1,34 +0,0 @@ -dictionaries: - - en - - en_GB - - fr - -# Any files/folders we should ignore? -excluded_files: - - "**/*.json" - - "**/*.svg" - - "pnpm-lock.yaml" - - ".markdownlintignore" - - ".prettierignore" - - ".eslintrc.yml" - - "vendor/**/*" - - "node_modules/**/*" - - "*.key" - - "*.enc" - - "*.min.css" - - "*.css.map" - - "*.min.js" - - "*.js.map" - - "*.mk" - - "package-lock.json" - - "yarn.lock" - - "Gemfile.lock" - - ".typo-ci.yml" - - ".github/.typo-ci.yml" - -# Any words we should ignore? -excluded_words: - - typoci - -# Would you like filenames to also be spellchecked? -spellcheck_filenames: true \ No newline at end of file diff --git a/.github/workflows/spelling.yml b/.github/workflows/spelling.yml index a5954fbae..dc66fabf9 100644 --- a/.github/workflows/spelling.yml +++ b/.github/workflows/spelling.yml @@ -1,6 +1,5 @@ name: PRSPELLCHECK on: [pull_request] - jobs: run: name: Spell Check with Typos diff --git a/.vitepress/config/en.ts b/.vitepress/config/en.ts index 41011d30d..0c4758c2f 100644 --- a/.vitepress/config/en.ts +++ b/.vitepress/config/en.ts @@ -346,6 +346,8 @@ export const enConfig: LocaleSpecificConfig< ['meta', { property: 'twitter:description', content: META_DESCRIPTION }], ['meta', { property: 'og:site_name', content: META_TITLE }], ['meta', { property: 'og:locale', content: 'en-US' }], + + ['meta', { property: 'og:image', content: `https://yuanshen.site/docs/imgs/cover.jpg` }], [ 'meta', { diff --git a/.vitepress/config/fr.ts b/.vitepress/config/fr.ts index ff971cc3c..6f4cd0c45 100644 --- a/.vitepress/config/fr.ts +++ b/.vitepress/config/fr.ts @@ -4,7 +4,6 @@ import path from 'path' import type { DefaultTheme, LocaleSpecificConfig } from 'vitepress' import type { CustomConfig } from './types' -const base = process.env.BASE || '/docs/' export const META_URL = 'https://yuanshen.site/docs/' export const META_TITLE = 'Genshin Interactive Map' export const META_KEYWORDS = @@ -12,152 +11,150 @@ export const META_KEYWORDS = export const META_DESCRIPTION = 'A Genshin interactive map by Kongying Tavern for completionists' -export const frConfig: LocaleSpecificConfig< - DefaultTheme.Config & CustomConfig -> = { +export const frConfig: LocaleSpecificConfig = { description: META_DESCRIPTION, - titleTemplate: 'Kongying Tavern', + titleTemplate: "Kongying Tavern", themeConfig: { - siteTitle: 'Genshin Interactive Map', - outlineTitle: 'On This Page', - logo: '/imgs/logo_256.png', - lastUpdatedText: 'Last updated', + siteTitle: "Genshin Interactive Map", + outlineTitle: "On This Page", + logo: "/imgs/logo_256.png", + lastUpdatedText: "Last updated", socialLinks: [ - { icon: 'github', link: 'https://github.com/kongying-tavern' }, + { icon: "github", link: "https://github.com/kongying-tavern" }, { icon: { svg: fs.readFileSync( - path.resolve(__dirname, '../../src/public/svg/reddit.svg'), - 'utf8' + path.resolve(__dirname, "../../src/public/svg/reddit.svg"), + "utf8" ), }, - link: 'https://www.reddit.com/user/Kongying_Tavern', + link: "https://www.reddit.com/user/Kongying_Tavern", }, - { icon: 'discord', link: 'https://discord.gg/aFe57AKZUF' }, - { icon: 'twitter', link: 'https://twitter.com/KongyingTavern' }, + { icon: "discord", link: "https://discord.gg/aFe57AKZUF" }, + { icon: "twitter", link: "https://twitter.com/KongyingTavern" }, ], docFooter: { - prev: 'Previous page', - next: 'Next page', + prev: "Previous page", + next: "Next page", }, editLink: { - pattern: 'https://github.com/kongying-tavern/docs/edit/next/src/:path', - text: 'Suggest changes to this page', + pattern: "https://github.com/kongying-tavern/docs/edit/next/src/:path", + text: "Suggest changes to this page", }, payment: { wechatpay: { - name: 'WeChat Pay', - address: 'wxp://f2f0dd1rszrnqJc_gnlwV_lRX5dlZ1Dtn9rp', + name: "WeChat Pay", + address: "wxp://f2f0dd1rszrnqJc_gnlwV_lRX5dlZ1Dtn9rp", }, alipay: { - name: 'Alipay', - address: 'https://qr.alipay.com/tsx11609thmpw9odmvdlxd6', + name: "Alipay", + address: "https://qr.alipay.com/tsx11609thmpw9odmvdlxd6", }, qqpay: { - name: 'QQ Pay', + name: "QQ Pay", address: - 'https://i.qianbao.qq.com/wallet/sqrcode.htm?m=tenpay&a=1&u=790489566&ac=CAEQ3tP3-AIY0v2k_AU%3D_xxx_sign&n=AAAAAAAA&f=wallet', + "https://i.qianbao.qq.com/wallet/sqrcode.htm?m=tenpay&a=1&u=790489566&ac=CAEQ3tP3-AIY0v2k_AU%3D_xxx_sign&n=AAAAAAAA&f=wallet", }, paypal: { - name: 'Paypal', - address: 'https://www.paypal.com/paypalme/yuanshenditu', + name: "Paypal", + address: "https://www.paypal.com/paypalme/yuanshenditu", }, bilibili: { - name: 'bilibili', - address: 'https://space.bilibili.com/518076785', + name: "bilibili", + address: "https://space.bilibili.com/518076785", }, }, nav: [ { - text: 'Download', - link: 'fr/download-client.md', + text: "Download", + link: "fr/download-client.md", }, { - text: 'Support us', - link: 'fr/support-us.md', + text: "Support us", + link: "fr/support-us.md", }, { - text: 'Community', - link: 'fr/community.md', + text: "Community", + link: "fr/community.md", }, { - text: 'Support', + text: "Support", items: [ { - text: 'Client User Manual', - link: 'fr/manual/client-user-manual.md', + text: "Client User Manual", + link: "fr/manual/client-user-manual.md", }, { - text: 'Feedback', - link: 'https://support.qq.com/products/321980', + text: "Feedback", + link: "https://support.qq.com/products/321980", }, { - text: 'New Features', - link: 'https://support.qq.com/products/321980/topic-detail/2016/', + text: "New Features", + link: "https://support.qq.com/products/321980/topic-detail/2016/", }, ], }, { - text: 'About', + text: "About", items: [ { - text: 'About Us', + text: "About Us", items: [ { - text: 'Join Us', - link: 'fr/join.md', + text: "Join Us", + link: "fr/join.md", }, { - text: 'Our Team', - link: 'fr/team.md', + text: "Our Team", + link: "fr/team.md", }, ], }, { - text: 'Update Log', + text: "Update Log", items: [ { - text: 'Web', - link: 'https://support.qq.com/products/321980/blog/505810', + text: "Web", + link: "https://support.qq.com/products/321980/blog/505810", }, { - text: 'Client', - link: 'https://discord.gg/SWz6RTWNkm', + text: "Client", + link: "https://discord.gg/SWz6RTWNkm", }, ], }, { - text: 'Acknowledgement', + text: "Acknowledgement", items: [ { - text: 'Credits', - link: 'fr/credits.md', + text: "Credits", + link: "fr/credits.md", }, { - text: 'Contributors', - link: 'fr/contribution.md', + text: "Contributors", + link: "fr/contribution.md", }, { - text: 'Sponsors', - link: 'fr/support-us.md#Sponsor%20Acknowledgements', + text: "Sponsors", + link: "fr/support-us.md#Sponsor%20Acknowledgements", }, ], }, { - text: 'Legal (Chinese)', + text: "Legal (Chinese)", items: [ { - text: 'Disclaimer', - link: 'fr/disclaimer.md', + text: "Disclaimer", + link: "fr/disclaimer.md", }, { - text: 'Privacy', - link: 'fr/privacy.md', + text: "Privacy", + link: "fr/privacy.md", }, { - text: 'Agreement', - link: 'fr/agreement.md', + text: "Agreement", + link: "fr/agreement.md", }, ], }, @@ -165,113 +162,113 @@ export const frConfig: LocaleSpecificConfig< }, ], sidebar: { - 'fr/manual': [ + "fr/manual": [ { - text: 'Table of Contents', - link: 'fr/manual/client-user-manual', + text: "Table of Contents", + link: "fr/manual/client-user-manual", }, { - text: 'Guides', + text: "Guides", items: [ { - text: 'Automatic Tracking', + text: "Automatic Tracking", items: [ { - text: 'Introduction', - link: 'fr/manual/guide/auto-tracking/importantnotes', + text: "Introduction", + link: "fr/manual/guide/auto-tracking/importantnotes", }, { - text: 'Troubleshooting', - link: 'fr/manual/guide/auto-tracking/troubleshoot', + text: "Troubleshooting", + link: "fr/manual/guide/auto-tracking/troubleshoot", }, ], }, { - text: 'Framerate/Tracking Control', - link: 'fr/manual/guide/bg/bgfrate', + text: "Framerate/Tracking Control", + link: "fr/manual/guide/bg/bgfrate", }, { - text: 'Multi Mark', - link: 'fr/manual/guide/batch-selection/instructions', + text: "Multi Mark", + link: "fr/manual/guide/batch-selection/instructions", }, { - text: 'Canvas Guide', - link: 'fr/manual/guide/canvas/guide', + text: "Canvas Guide", + link: "fr/manual/guide/canvas/guide", }, { - text: 'Easter Egg', - link: 'fr/manual/guide/easter-egg/view', + text: "Easter Egg", + link: "fr/manual/guide/easter-egg/view", }, { - text: 'Hide/Show Found', - link: 'fr/manual/guide/hide-show-done/hidedoneshowdone', + text: "Hide/Show Found", + link: "fr/manual/guide/hide-show-done/hidedoneshowdone", }, { - text: 'Overlay Mode', + text: "Overlay Mode", items: [ { - text: 'Instructions', - link: 'fr/manual/guide/overlay-mode/instructions', + text: "Instructions", + link: "fr/manual/guide/overlay-mode/instructions", }, { - text: 'Windowed Fullscreen', - link: 'fr/manual/guide/overlay-mode/fullscreen-windowed/launching', + text: "Windowed Fullscreen", + link: "fr/manual/guide/overlay-mode/fullscreen-windowed/launching", }, ], }, { - text: 'Restore/Recover Progress', - link: 'fr/manual/guide/restore-recover/progress', + text: "Restore/Recover Progress", + link: "fr/manual/guide/restore-recover/progress", }, ], }, { - text: 'FAQ', + text: "FAQ", items: [ { - text: 'Account safety', - link: 'fr/manual/faq/accountsafety/acntban.md', + text: "Account safety", + link: "fr/manual/faq/accountsafety/acntban.md", }, { - text: 'Auto Update', - link: 'fr/manual/faq/autoupdate/updater.md', + text: "Auto Update", + link: "fr/manual/faq/autoupdate/updater.md", }, { - text: 'Installation Error', + text: "Installation Error", items: [ { - text: 'Code 2503', - link: 'fr/manual/faq/instlerror/code2503.md', + text: "Code 2503", + link: "fr/manual/faq/instlerror/code2503.md", }, { - text: 'Missing .dll file', - link: 'fr/manual/faq/instlerror/missingdll.md', + text: "Missing .dll file", + link: "fr/manual/faq/instlerror/missingdll.md", }, ], }, { - text: 'Launch Error', + text: "Launch Error", items: [ { - text: 'Stuck/No Progress', - link: 'fr/manual/faq/launcherror/emptydialog.md', + text: "Stuck/No Progress", + link: "fr/manual/faq/launcherror/emptydialog.md", }, { - text: 'Version Check Failed', - link: 'fr/manual/faq/launcherror/versioncheck.md', + text: "Version Check Failed", + link: "fr/manual/faq/launcherror/versioncheck.md", }, ], }, { - text: 'About Login', + text: "About Login", items: [ { - text: 'Login Problems', - link: 'fr/manual/faq/login/accountlogin.md', + text: "Login Problems", + link: "fr/manual/faq/login/accountlogin.md", }, { - text: 'Repeated Login Requests', - link: 'fr/manual/faq/login/clientrepeatedly.md', + text: "Repeated Login Requests", + link: "fr/manual/faq/login/clientrepeatedly.md", }, ], }, @@ -280,58 +277,58 @@ export const frConfig: LocaleSpecificConfig< ], }, footer: { - qrcodeTitle: 'Discord Server', - qrcodeMessage: 'Contact us on discord', - qrcodeLink: 'https://discord.gg/aFe57AKZUF', + qrcodeTitle: "Discord Server", + qrcodeMessage: "Contact us on discord", + qrcodeLink: "https://discord.gg/aFe57AKZUF", navigation: [ { - title: 'About', + title: "About", items: [ { - text: 'Join Us', - link: 'fr/join', + text: "Join Us", + link: "fr/join", }, { - text: 'Our team', - link: 'fr/team', + text: "Our team", + link: "fr/team", }, { - text: 'Sponsors', - link: 'fr/support-us', + text: "Sponsors", + link: "fr/support-us", }, ], }, { - title: 'Legal (Chinese)', + title: "Legal (Chinese)", items: [ { - text: 'Disclaimer', - link: 'fr/disclaimer', + text: "Disclaimer", + link: "fr/disclaimer", }, { - text: 'Privacy', - link: 'fr/privacy', + text: "Privacy", + link: "fr/privacy", }, { - text: 'Agreement', - link: 'fr/agreement', + text: "Agreement", + link: "fr/agreement", }, ], }, { - title: 'Support', + title: "Support", items: [ { - text: 'Client User Manual', - link: 'fr/manual/client-user-manual', + text: "Client User Manual", + link: "fr/manual/client-user-manual", }, { - text: 'Feedback', - link: 'https://support.qq.com/products/321980', + text: "Feedback", + link: "https://support.qq.com/products/321980", }, { - text: 'New Features', - link: 'https://support.qq.com/products/321980/topic-detail/2016/', + text: "New Features", + link: "https://support.qq.com/products/321980/topic-detail/2016/", }, ], }, @@ -339,21 +336,21 @@ export const frConfig: LocaleSpecificConfig< }, }, head: [ - ['meta', { name: 'keywords', content: META_KEYWORDS }], - ['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 }], - ['meta', { property: 'og:site_name', content: META_TITLE }], - ['meta', { property: 'og:locale', content: 'en-US' }], - ['meta', { property: 'og:image', content: `${base}/imgs/cover.jpg` }], + ["meta", { name: "keywords", content: META_KEYWORDS }], + ["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 }], + ["meta", { property: "og:site_name", content: META_TITLE }], + ["meta", { property: "og:locale", content: "en-US" }], + ["meta", { property: "og:image", content: `${META_URL}imgs/cover.jpg` }], [ - 'meta', + "meta", { - name: 'twitter:image', - content: `${base}/imgs/cover.jpg`, + name: "twitter:image", + content: `${META_URL}imgs/cover.jpg`, }, ], ], -} +}; diff --git a/.vitepress/config/zh.ts b/.vitepress/config/zh.ts index e27217a39..2a2eb4235 100644 --- a/.vitepress/config/zh.ts +++ b/.vitepress/config/zh.ts @@ -23,6 +23,7 @@ export const zhConfig: LocaleSpecificConfig< ['meta', { property: 'og:site_name', content: META_TITLE }], ['meta', { property: 'twitter:description', content: META_DESCRIPTION }], ['meta', { property: 'og:locale', content: 'zh-CN' }], + ['meta', { property: 'og:image', content: `https://yuanshen.site/docs/imgs/cover.jpg` }], [ 'meta', { diff --git a/src/index.md b/src/index.md index 32e65b232..5d5553d81 100644 --- a/src/index.md +++ b/src/index.md @@ -43,15 +43,12 @@ hero: - theme: brand slide-enter text: 立即下载 → link: ./download-client - - theme: alt - text: 用户手册 - link: manual/client-user-manual.md - theme: cta video slide-enter text: 基础使用教程 link: https://bilibili.com/video/BV1R84y1M7eu - theme: cta mastery slide-enter text: 客户端使用手册 - link: https://support.qq.com/products/321980/faqs-more/?id=94938 + link: manual/client-user-manual.md ---