diff --git a/.github/workflows/documents.yml b/.github/workflows/documents.yml index 4ca88a68..a97175ea 100644 --- a/.github/workflows/documents.yml +++ b/.github/workflows/documents.yml @@ -40,7 +40,7 @@ jobs: working-directory: docs - name: Build - run: yarn docs:build + run: COMMIT_REF=$(git rev-parse HEAD) yarn docs:build working-directory: docs - name: Archive artifacts diff --git a/docs/.vitepress/config/common.ts b/docs/.vitepress/config/common.ts new file mode 100644 index 00000000..31759235 --- /dev/null +++ b/docs/.vitepress/config/common.ts @@ -0,0 +1,3 @@ +export const projectUrl: string = "https://github.com/0xJacky/nginx-ui" +export const demoUrl: string = "https://demo.nginxui.com" +export const editLinkPattern: string = projectUrl + '/edit/master/docs/:path' diff --git a/docs/.vitepress/config/en.ts b/docs/.vitepress/config/en.ts index e7d2cfa9..ca571386 100644 --- a/docs/.vitepress/config/en.ts +++ b/docs/.vitepress/config/en.ts @@ -1,11 +1,12 @@ import {LocaleSpecificConfig, DefaultTheme} from "vitepress" +import {demoUrl} from './common' export const enConfig: LocaleSpecificConfig = { themeConfig: { nav: [ {text: 'Home', link: '/'}, {text: 'Guide', link: '/guide/about'}, - {text: 'Demo', link: 'https://demo.nginxui.com'} + {text: 'Demo', link: demoUrl} ], sidebar: { diff --git a/docs/.vitepress/config/shared.ts b/docs/.vitepress/config/shared.ts index 49c26c9b..fdd936ab 100644 --- a/docs/.vitepress/config/shared.ts +++ b/docs/.vitepress/config/shared.ts @@ -1,4 +1,9 @@ import { defineConfig } from 'vitepress' +import {projectUrl, editLinkPattern} from './common' + +export const commitRef = process.env.COMMIT_REF ? + `` + process.env.COMMIT_REF.slice(0, 8) + '': + 'dev' function thisYear() { return new Date().getFullYear() @@ -8,6 +13,11 @@ export const sharedConfig = defineConfig({ title: 'Nginx UI', description: 'Yet another Nginx Web UI', + head: [ + ['link', { rel: 'icon', type: 'image/svg+xml', href: '/assets/logo.svg' }], + ['meta', { name: 'theme-color', content: '#3682D8' }] + ], + lastUpdated: true, themeConfig: { @@ -18,16 +28,16 @@ export const sharedConfig = defineConfig({ }, editLink: { - pattern: 'https://github.com/0xJacky/nginx-ui/edit/master/docs/:path' + pattern: editLinkPattern }, footer: { - message: 'Released under the AGPL-3.0 License.', + message: `Released under the AGPL-3.0 License. (${commitRef})`, copyright: 'Copyright © 2021-' + thisYear() + ' Nginx UI Team' }, socialLinks: [ - {icon: 'github', link: 'https://github.com/0xJacky/nginx-ui'} + {icon: 'github', link: projectUrl} ] } }) diff --git a/docs/.vitepress/config/zh_CN.ts b/docs/.vitepress/config/zh_CN.ts index fe51c7a1..89e5a4a5 100644 --- a/docs/.vitepress/config/zh_CN.ts +++ b/docs/.vitepress/config/zh_CN.ts @@ -1,16 +1,17 @@ import {LocaleSpecificConfig, DefaultTheme} from "vitepress" +import {demoUrl, editLinkPattern} from './common' export const zhCNConfig: LocaleSpecificConfig = { themeConfig: { nav: [ {text: '首页', link: '/zh_CN/'}, {text: '手册', link: '/zh_CN/guide/about'}, - {text: '演示', link: 'https://demo.nginxui.com'} + {text: '演示', link: demoUrl} ], editLink: { text: '编辑此页', - pattern: 'https://github.com/0xJacky/nginx-ui/edit/master/docs/:path' + pattern: editLinkPattern }, sidebar: { diff --git a/docs/package.json b/docs/package.json index 98b02a42..9372a074 100644 --- a/docs/package.json +++ b/docs/package.json @@ -10,6 +10,8 @@ "vitepress": "^1.0.0-alpha.75" }, "devDependencies": { + "@types/node": "^20.1.0", "less": "^4.1.3" - } + }, + "license": "AGPL-3.0" } diff --git a/docs/yarn.lock b/docs/yarn.lock index 97435620..f1f795ff 100644 --- a/docs/yarn.lock +++ b/docs/yarn.lock @@ -427,6 +427,13 @@ __metadata: languageName: node linkType: hard +"@types/node@npm:^20.1.0": + version: 20.1.0 + resolution: "@types/node@npm:20.1.0" + checksum: c6d9afa9aa78b4b4348c69ece94975be70346b144c278f1395694a10ef919d7db300018101b6f9245e6bdd76674a5327d2d14829092f3d5295e858cff5f22a66 + languageName: node + linkType: hard + "@types/web-bluetooth@npm:^0.0.17": version: 0.0.17 resolution: "@types/web-bluetooth@npm:0.0.17" @@ -1448,6 +1455,7 @@ __metadata: version: 0.0.0-use.local resolution: "nginx-ui-docs@workspace:." dependencies: + "@types/node": ^20.1.0 less: ^4.1.3 vitepress: ^1.0.0-alpha.75 languageName: unknown