Skip to content

Commit

Permalink
prettier fix format
Browse files Browse the repository at this point in the history
  • Loading branch information
@ShintoKosei
ShintoKosei committed Jun 3, 2024
1 parent e6e976f commit a43ca0b
Show file tree
Hide file tree
Showing 146 changed files with 1,249 additions and 1,176 deletions.
10 changes: 5 additions & 5 deletions .github/workflows/build-docs.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,15 @@ name: build-docs
on:
# 当推送到"main"分支时触发
push:
branches: ["main"]
branches: ['main']
# 当提交Pr时触发
pull_request:
# 允许手动触发此工作流
workflow_dispatch:

env:
# 当工作流被Pr触发则显示警告
PR_PROMPT: "::warning:: 工作流由Pr拉取请求触发，构建产物不会上传、跳过页面部署任务。"
PR_PROMPT: '::warning:: 工作流由Pr拉取请求触发，构建产物不会上传、跳过页面部署任务。'

# 设置 GITHUB_TOKEN 的权限以允许部署到 GitHub Pages
permissions:
Expand All @@ -21,7 +21,7 @@ permissions:

# 仅允许一个并发部署
concurrency:
group: "pages"
group: 'pages'
cancel-in-progress: false

jobs:
Expand All @@ -46,7 +46,7 @@ jobs:
- name: 运行构建脚本
run: pnpm build
- name: 上传构建产物
if: ${{ !github.head_ref }} # 需满非Pr提交
if: ${{ !github.head_ref }} # 需满非Pr提交
uses: actions/upload-pages-artifact@v2
with:
path: ./docs/.vuepress/dist
Expand All @@ -62,4 +62,4 @@ jobs:
steps:
- name: 部署到 GitHub Pages
id: deployment
uses: actions/deploy-pages@v2
uses: actions/deploy-pages@v2
256 changes: 136 additions & 120 deletions docs/.vuepress/config.ts
View file
Original file line number Diff line number Diff line change
@@ -1,136 +1,152 @@
import { viteBundler } from '@vuepress/bundler-vite'
import { defineUserConfig } from 'vuepress'
import { defaultTheme } from '@vuepress/theme-default'
import { searchProPlugin } from "vuepress-plugin-search-pro";
import { searchProPlugin } from 'vuepress-plugin-search-pro'
import { shikiPlugin } from '@vuepress/plugin-shiki'
import {
navbarZh,
navbarZht,
navbarEn,
sidebarZh,
sidebarZht,
sidebarEn,
navbarZh,
navbarZht,
navbarEn,
sidebarZh,
sidebarZht,
sidebarEn,
} from './configs/index.ts'

export default defineUserConfig({
bundler: viteBundler(),
locales: {
'/': {
lang: 'zh-CN',
title: 'Axiom 中文文档',
description: 'Axiom 中文文档。提供Axiom 官方文档页面的中文翻译，使在遇到难以解决的问题时有解决方案可寻',
},
'/zht/': {
lang: 'zh-hant',
title: 'Axiom 中文文檔',
description: 'Axiom 中文文檔。提供Axiom 官方文檔頁面的中文翻譯，使在遇到難以解決的問題時有解決方案可尋',
},
'/en/': {
lang: 'en-US',
title: 'Axiom Chinese Documentation',
description: 'Axiom Chinese Documentation. Provides a Chinese translation of the official documentation page for the Axiom, offering solutions when encountering challenging issues',
},
bundler: viteBundler(),
locales: {
'/': {
lang: 'zh-CN',
title: 'Axiom 中文文档',
description:
'Axiom 中文文档。提供Axiom 官方文档页面的中文翻译，使在遇到难以解决的问题时有解决方案可寻',
},
'/zht/': {
lang: 'zh-hant',
title: 'Axiom 中文文檔',
description:
'Axiom 中文文檔。提供Axiom 官方文檔頁面的中文翻譯，使在遇到難以解決的問題時有解決方案可尋',
},
'/en/': {
lang: 'en-US',
title: 'Axiom Chinese Documentation',
description:
'Axiom Chinese Documentation. Provides a Chinese translation of the official documentation page for the Axiom, offering solutions when encountering challenging issues',
},
head: [
['meta', { name: 'keywords', content: 'Axiom,MOD,AxiomMOD,Minecraft,MC,Wiki,Docs,公理,公理模组,文档,文库,百科,维基,我的世界' }],
['meta', { name: 'viewport', content: 'width=device-width, initial-scale=1' }],
["link", { rel: "icon", href: "/images/axiom_icon.svg" }],
['meta', { name: 'msvalidate.01', content: 'F0CB8A76E937BF0133C54D35F5D60107' }], //Bing
},
head: [
[
'meta',
{
name: 'keywords',
content:
'Axiom,MOD,AxiomMOD,Minecraft,MC,Wiki,Docs,公理,公理模组,文档,文库,百科,维基,我的世界',
},
],
theme: defaultTheme({
// 默认主题配置
colorMode: 'dark',
colorModeSwitch: false,
logo: "/images/axiom_icon.svg",
repo: 'ShintoKosei/Axiom-CN-Documentation',
editLink: false,
contributors: false,
[
'meta',
{ name: 'viewport', content: 'width=device-width, initial-scale=1' },
],
['link', { rel: 'icon', href: '/images/axiom_icon.svg' }],
[
'meta',
{ name: 'msvalidate.01', content: 'F0CB8A76E937BF0133C54D35F5D60107' },
], //Bing
],
theme: defaultTheme({
// 默认主题配置
colorMode: 'dark',
colorModeSwitch: false,
logo: '/images/axiom_icon.svg',
repo: 'ShintoKosei/Axiom-CN-Documentation',
editLink: false,
contributors: false,

locales: {
'/': {
selectLanguageName: '简体中文',
home: '/',
navbar: navbarZh,
sidebar: sidebarZh,
lastUpdatedText: '最后更新',
contributorsText: '贡献者列表',
tip: '提示',
warning: '警告',
danger: '危险',
notFound: [
'你来到了没有文字的荒野',
'页面不见了',
'这里什么都没有',
'我们怎么到这来了？',
'这是一个 404 页面',
'看起来我们进入了错误的链接',
],
backToHome: '返回首页',
openInNewWindow: '在新窗口打开',
toggleColorMode: '切换颜色模式',
toggleSidebar: '切换侧边栏',
selectLanguageText: '选择语言',
selectLanguageAriaLabel: '选择语言',
},
locales: {
'/': {
selectLanguageName: '简体中文',
home: '/',
navbar: navbarZh,
sidebar: sidebarZh,
lastUpdatedText: '最后更新',
contributorsText: '贡献者列表',
tip: '提示',
warning: '警告',
danger: '危险',
notFound: [
'你来到了没有文字的荒野',
'页面不见了',
'这里什么都没有',
'我们怎么到这来了？',
'这是一个 404 页面',
'看起来我们进入了错误的链接',
],
backToHome: '返回首页',
openInNewWindow: '在新窗口打开',
toggleColorMode: '切换颜色模式',
toggleSidebar: '切换侧边栏',
selectLanguageText: '选择语言',
selectLanguageAriaLabel: '选择语言',
},

'/zht/': {
selectLanguageName: '繁體中文',
home: '/zht/',
navbar: navbarZht,
sidebar: sidebarZht,
lastUpdatedText: '最後更新',
contributorsText: '貢獻者列表',
tip: '提示',
warning: '警告',
danger: '危險',
notFound: [
'你來到了沒有文字的荒野',
'頁面不見了',
'這裡什麼都沒有',
'我們怎麼到這來了？',
'這是一個 404 頁面',
'看起來我們進入了錯誤的鏈接',
],
backToHome: '返回首頁',
openInNewWindow: '在新窗口打開',
toggleColorMode: '切換顏色模式',
toggleSidebar: '切換側邊欄',
selectLanguageText: '選擇語言',
selectLanguageAriaLabel: '選擇語言',
},
'/zht/': {
selectLanguageName: '繁體中文',
home: '/zht/',
navbar: navbarZht,
sidebar: sidebarZht,
lastUpdatedText: '最後更新',
contributorsText: '貢獻者列表',
tip: '提示',
warning: '警告',
danger: '危險',
notFound: [
'你來到了沒有文字的荒野',
'頁面不見了',
'這裡什麼都沒有',
'我們怎麼到這來了？',
'這是一個 404 頁面',
'看起來我們進入了錯誤的鏈接',
],
backToHome: '返回首頁',
openInNewWindow: '在新窗口打開',
toggleColorMode: '切換顏色模式',
toggleSidebar: '切換側邊欄',
selectLanguageText: '選擇語言',
selectLanguageAriaLabel: '選擇語言',
},

'/en/': {
selectLanguageName: 'English',
home: '/en/',
navbar: navbarEn,
sidebar: sidebarEn,
editLinkText: 'Edit this page on GitHub',
},
},
}),
'/en/': {
selectLanguageName: 'English',
home: '/en/',
navbar: navbarEn,
sidebar: sidebarEn,
editLinkText: 'Edit this page on GitHub',
},
},
}),

pages: {
'/': {
title: 'Axiom 中文文档 | 船新Minecraft建筑模组中文文档'
},
// '/en/': {
// title: '页面2的标题'
// },
'/zht/': {
title: 'Axiom 中文文檔 | 船新Minecraft建築模組中文文檔'
},
pages: {
'/': {
title: 'Axiom 中文文档 | 船新Minecraft建筑模组中文文档',
},
plugins: [
searchProPlugin({
// 配置选项
}),
shikiPlugin({
// 配置项
theme: 'github-dark',
}),
],
// '/en/': {
// title: '页面2的标题'
// },
'/zht/': {
title: 'Axiom 中文文檔 | 船新Minecraft建築模組中文文檔',
},
},
plugins: [
searchProPlugin({
// 配置选项
}),
shikiPlugin({
// 配置项
theme: 'github-dark',
}),
],

// Dev 配置项
host: '0.0.0.0',
port: 9364,
});
// Dev 配置项
host: '0.0.0.0',
port: 9364,
})
4 changes: 2 additions & 2 deletions docs/.vuepress/configs/index.ts
View file
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
export * from './navbar/index.ts'
export * from './sidebar/index.ts'
export * from './navbar/index.ts'
export * from './sidebar/index.ts'
32 changes: 16 additions & 16 deletions docs/.vuepress/configs/navbar/en.ts
View file
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
import type { NavbarConfig } from '@vuepress/theme-default'

export const navbarEn: NavbarConfig = [
{ text: "Home", link: "/en/" },
{
text: 'Get Started🚀',
children: [
'/en/intro/intro.md',
'/en/builder/intro.md',
'/en/capabilities/intro.md',
'/en/editor/intro.md',
'/en/tools/intro.md',
'/en/advanced/intro.md',
],
},
]
import type { NavbarConfig } from '@vuepress/theme-default'

export const navbarEn: NavbarConfig = [
{ text: 'Home', link: '/en/' },
{
text: 'Get Started🚀',
children: [
'/en/intro/intro.md',
'/en/builder/intro.md',
'/en/capabilities/intro.md',
'/en/editor/intro.md',
'/en/tools/intro.md',
'/en/advanced/intro.md',
],
},
]
6 changes: 3 additions & 3 deletions docs/.vuepress/configs/navbar/index.ts
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
export * from './zh.ts'
export * from './zht.ts'
export * from './en.ts'
export * from './zh.ts'
export * from './zht.ts'
export * from './en.ts'
32 changes: 16 additions & 16 deletions docs/.vuepress/configs/navbar/zh.ts
View file
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
import type { NavbarConfig } from '@vuepress/theme-default'

export const navbarZh: NavbarConfig = [
{ text: "首页", link: "/" },
{
text: '快速开始🚀',
children: [
'/intro/intro.md',
'/builder/intro.md',
'/capabilities/intro.md',
'/editor/intro.md',
'/tools/intro.md',
'/advanced/intro.md',
],
},
]
import type { NavbarConfig } from '@vuepress/theme-default'

export const navbarZh: NavbarConfig = [
{ text: '首页', link: '/' },
{
text: '快速开始🚀',
children: [
'/intro/intro.md',
'/builder/intro.md',
'/capabilities/intro.md',
'/editor/intro.md',
'/tools/intro.md',
'/advanced/intro.md',
],
},
]
Loading

0 comments on commit a43ca0b

Please sign in to comment.