Skip to content

Commit

Permalink
update doc
Browse files Browse the repository at this point in the history
  • Loading branch information
@gezhaoyou
gezhaoyou committed Jul 22, 2024
1 parent 9f4886f commit f4a5968
Show file tree
Hide file tree
Showing 50 changed files with 1,780 additions and 1,029 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/build-deploy-website.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ on:
# Runs on pushes targeting the `main` branch. Change this to `master` if you're
# using the `master` branch as the default branch.
push:
branches: [docs]
branches: [main]

# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:
Expand Down
10 changes: 5 additions & 5 deletions docs/docs/.vitepress/config/en.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,13 @@ export const en = defineConfig({
},

editLink: {
pattern: 'https://github.com/vuejs/vitepress/edit/main/docs/:path',
pattern: 'https://github.com/pixpark/gpupixel/edit/main/docs/:path',
text: 'Edit this page on GitHub'
},

footer: {
message: 'Released under the MIT License.',
copyright: 'Copyright © 2019-present Evan You'
copyright: 'Copyright © 2019-present PixPark'
}
}
})
Expand All @@ -32,7 +32,7 @@ function nav(): DefaultTheme.NavItem[] {
return [
{
text: 'Guide',
link: '/guide/what-is-vitepress',
link: '/guide/intro',
activeMatch: '/guide/'
},
{
Expand All @@ -45,11 +45,11 @@ function nav(): DefaultTheme.NavItem[] {
items: [
{
text: 'Changelog',
link: 'https://github.com/vuejs/vitepress/blob/main/CHANGELOG.md'
link: 'https://github.com/pixpark/gpupixel/blob/main/CHANGELOG.md'
},
{
text: 'Contributing',
link: 'https://github.com/vuejs/vitepress/blob/main/.github/contributing.md'
link: 'https://github.com/pixpark/gpupixel/issues/new/choose'
}
]
}
Expand Down
16 changes: 8 additions & 8 deletions docs/docs/.vitepress/config/shared.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,31 +21,31 @@ export const shared = defineConfig({
},

sitemap: {
hostname: 'https://vitepress.dev',
hostname: 'https://open.pixpark.net/gpupixel',
transformItems(items) {
return items.filter((item) => !item.url.includes('migration'))
}
},

/* prettier-ignore */
head: [
['link', { rel: 'icon', type: 'image/svg+xml', href: '/vitepress-logo-mini.svg' }],
['link', { rel: 'icon', type: 'image/png', href: '/vitepress-logo-mini.png' }],
['link', { rel: 'icon', type: 'image/svg+xml', href: '/gpupixel-logo-mini.svg' }],
['link', { rel: 'icon', type: 'image/png', href: '/gpupixel-logo-mini.svg' }],
['meta', { name: 'theme-color', content: '#5f67ee' }],
['meta', { property: 'og:type', content: 'website' }],
['meta', { property: 'og:locale', content: 'en' }],
['meta', { property: 'og:title', content: 'VitePress | Vite & Vue Powered Static Site Generator' }],
['meta', { property: 'og:site_name', content: 'VitePress' }],
['meta', { property: 'og:title', content: 'GPUPixel | Realtime Image filter Lib' }],
['meta', { property: 'og:site_name', content: 'GPUPixel' }],
['meta', { property: 'og:image', content: 'https://vitepress.dev/vitepress-og.jpg' }],
['meta', { property: 'og:url', content: 'https://vitepress.dev/' }],
['meta', { property: 'og:url', content: 'https://gpupixel.pixpark.net/' }],
['script', { src: 'https://cdn.usefathom.com/script.js', 'data-site': 'AZBRSFGG', 'data-spa': 'auto', defer: '' }]
],

themeConfig: {
logo: { src: '/vitepress-logo-mini.svg', width: 24, height: 24 },
logo: { src: '/gpupixel-logo-mini.svg', width: 20, height: 20 },

socialLinks: [
{ icon: 'github', link: 'https://github.com/vuejs/vitepress' }
{ icon: 'github', link: 'https://github.com/pixpark/gpupixel' }
],

search: {
Expand Down
87 changes: 29 additions & 58 deletions docs/docs/.vitepress/config/zh.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ const pkg = require('vitepress/package.json')

export const zh = defineConfig({
lang: 'zh-Hans',
description: '由 Vite 和 Vue 驱动的静态站点生成器',
description: 'Cross-Platform AI Beauty Effects Library, Achieving Commercial-Grade Beauty Effects. Written in C++11, Based on OpenGL/ES and VNN.',

themeConfig: {
nav: nav(),
Expand All @@ -17,7 +17,7 @@ export const zh = defineConfig({
},

editLink: {
pattern: 'https://github.com/vuejs/vitepress/edit/main/docs/:path',
pattern: 'https://github.com/pixpark/gpupixel/edit/main/docs/:path',
text: '在 GitHub 上编辑此页面'
},

Expand All @@ -32,7 +32,7 @@ export const zh = defineConfig({
},

outline: {
label: '页面导航'
label: '文章内容'
},

lastUpdated: {
Expand All @@ -56,27 +56,31 @@ function nav(): DefaultTheme.NavItem[] {
return [
{
text: '指南',
link: '/zh/guide/what-is-gpupixel',
link: '/zh/guide/intro',
activeMatch: '/zh/guide/'
},
{
text: '参考',
link: '/zh/reference/site-config',
text: '参考',
link: '/zh/reference/filter-list',
activeMatch: '/zh/reference/'
},
{
text: pkg.version,
items: [
{
text: '更新日志',
link: 'https://github.com/vuejs/vitepress/blob/main/CHANGELOG.md'
link: 'https://github.com/pixpark/gpupixel/blob/main/CHANGELOG.md'
},
{
text: '参与贡献',
link: 'https://github.com/vuejs/vitepress/blob/main/.github/contributing.md'
link: 'https://github.com/pixpark/gpupixel/issues/new/choose'
}
]
}
},
{
text: 'PixPark',
link: 'https://pixpark.net',
},
]
}

Expand All @@ -86,50 +90,39 @@ function sidebarGuide(): DefaultTheme.SidebarItem[] {
text: '快速开始',
collapsed: false,
items: [
{ text: '简介', link: 'what-is-gpupixel' },
{ text: '运行Demo', link: 'what-is-gpupixel' },
]
},
{
text: '集成&调用',
collapsed: false,
items: [
{ text: 'Android', link: 'what-is-gpupixel' },
{ text: 'iOS', link: 'what-is-gpupixel' },
{ text: 'Windows', link: 'what-is-gpupixel' },
{ text: 'MacOS', link: 'what-is-gpupixel' },
{ text: 'Linux', link: 'what-is-gpupixel' },
{ text: 'Web', link: 'what-is-gpupixel' },
{ text: 'Python', link: 'what-is-gpupixel' },
{ text: '简介', link: 'intro' },
{ text: '编译', link: 'build' },
{ text: '示例', link: 'demo' },
{ text: '集成', link: 'integrated' },
]
},
{
text: '编译&调试',
text: '接口调用',
collapsed: false,
items: [
{ text: 'Android', link: 'what-is-gpupixel' },
{ text: 'iOS', link: 'what-is-gpupixel' },
{ text: 'Desktop', link: 'what-is-gpupixel' },
{ text: 'Web', link: 'what-is-gpupixel' },
{ text: 'Python', link: 'what-is-gpupixel' },
{ text: '基础滤镜', link: '#' },
{ text: '美妆特效', link: '#' },
{ text: '输入输出', link: '#' },
]
},
{
text: '自定义',
collapsed: false,
items: [
{ text: '自定义滤镜', link: 'custom-theme' },
{ text: '自定义滤镜', link: '#' },
{ text: '自定义输入', link: '#' },
{ text: '自定义输出', link: '#' },
]
},
{
text: '实验性功能',
text: '其他',
collapsed: false,
items: [
{ text: 'MPA 模式', link: 'mpa-mode' },
{ text: 'sitemap 生成', link: 'sitemap-generation' }
{ text: '架构分析', link: '#' },
{ text: '代码调试', link: '#' },
]
},
{ text: '配置和 API 参考', base: '/zh/reference/', link: 'site-config' }
{ text: '配置和 API 参考', base: '/zh/reference/', link: 'filter-list' }
]
}

Expand All @@ -138,29 +131,7 @@ function sidebarReference(): DefaultTheme.SidebarItem[] {
{
text: '参考',
items: [
{ text: '站点配置', link: 'site-config' },
{ text: 'frontmatter 配置', link: 'frontmatter-config' },
{ text: '运行时 API', link: 'runtime-api' },
{ text: 'CLI', link: 'cli' },
{
text: '默认主题',
base: '/zh/reference/default-theme-',
items: [
{ text: '概览', link: 'config' },
{ text: '导航栏', link: 'nav' },
{ text: '侧边栏', link: 'sidebar' },
{ text: '主页', link: 'home-page' },
{ text: '页脚', link: 'footer' },
{ text: '布局', link: 'layout' },
{ text: '徽章', link: 'badge' },
{ text: '团队页', link: 'team-page' },
{ text: '上下页链接', link: 'prev-next-links' },
{ text: '编辑链接', link: 'edit-link' },
{ text: '最后更新时间戳', link: 'last-updated' },
{ text: '搜索', link: 'search' },
{ text: 'Carbon Ads', link: 'carbon-ads' }
]
}
{ text: '滤镜列表', link: 'filter-list' },
]
}
]
Expand Down
49 changes: 0 additions & 49 deletions docs/docs/en/guide/api-examples.md
View file

This file was deleted.

Loading

0 comments on commit f4a5968

Please sign in to comment.