Skip to content

Commit

Permalink
chore: update vitepress
Browse files Browse the repository at this point in the history
Signed-off-by: Sepush <[email protected]>
  • Loading branch information
Sepush committed Dec 17, 2023
1 parent 0bee39d commit 0c3ddfe
Show file tree
Hide file tree
Showing 8 changed files with 747 additions and 488 deletions.
26 changes: 10 additions & 16 deletions docs-zh/.vitepress/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,15 @@ export default defineConfig({
lang: 'zh-CN',
lastUpdated: true,
locales: {
'/': {
lang: 'zh-CN',
title: 'envd',
description: 'AI/ML 开发环境'
root:{
label:'简体中文',
lang:'zh',
},
zh:{
label:'English',
lang:'en',
link:'https://envd.tensorchord.ai'
}
},
title: 'envd',

Expand Down Expand Up @@ -54,19 +58,9 @@ export default defineConfig({
light: '/logo_light.svg',
dark: '/logo_dark.svg',
},
algolia: {
appId: 'KGSWV0XY1D',
apiKey: 'a3c4e766b63fac5bee147fb9fc269cb0',
indexName: 'tensorchord',
},
localeLinks: {
text: '',
items: [
{ text: 'English', link: 'https://envd.tensorchord.ai' },
{ text: '简体中文', link: '/' },
],
search:{
provider: 'local'
},

socialLinks: [
{ icon: 'github', link: 'https://github.com/tensorchord/envd' },
{ icon: 'twitter', link: 'https://twitter.com/TensorChord' },
Expand Down
2 changes: 1 addition & 1 deletion docs-zh/.vitepress/config/sidebar/api.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ export const apiSidebar: DefaultTheme.Sidebar = {
'/api/': [
{
text: 'envd CLI',
collapsible: true,
collapsed: true,
items: [
{ text: 'CLI references', link: '/api/cli/cli' },
]
Expand Down
16 changes: 8 additions & 8 deletions docs-zh/.vitepress/config/sidebar/main.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ export const mainSidebar: DefaultTheme.Sidebar = {
'/': [
{
text: '开始了解',
collapsible: true,
collapsed: true,
items: [
{ text: '快速开始', link: '/guide/getting-started' },
{ text: '构建你的开发环境', link: '/guide/build-envd' },
Expand All @@ -16,7 +16,7 @@ export const mainSidebar: DefaultTheme.Sidebar = {
},
{
text: '管理 envd 环境',
collapsible: true,
collapsed: true,
items: [
{ text: '利用软件镜像源更快地构建环境', link: '/envs/mirror' },
{ text: '用户相关配置', link: '/envs/config' },
Expand All @@ -26,7 +26,7 @@ export const mainSidebar: DefaultTheme.Sidebar = {
},
{
text: '在团队中使用 envd',
collapsible: true,
collapsed: true,
items: [
{ text: '总览', link: '/teams/overview'},
{ text: '在 Kubernetes 上使用 envd (试验性)', link: '/teams/kubernetes'},
Expand All @@ -37,7 +37,7 @@ export const mainSidebar: DefaultTheme.Sidebar = {
},
{
text: '编程语言',
collapsible: true,
collapsed: true,
items: [
{ text: 'Python 语言', link: '/lang/python' },
{ text: 'Julia 语言', link: '/lang/julia' },
Expand All @@ -46,7 +46,7 @@ export const mainSidebar: DefaultTheme.Sidebar = {
},
{
text: '社区',
collapsible: true,
collapsed: true,
items: [
{ text: '加入社区', link: '/community/community' },
{ text: '贡献 envd', link: '/community/contributing' },
Expand All @@ -55,23 +55,23 @@ export const mainSidebar: DefaultTheme.Sidebar = {
},
{
text: '开发者',
collapsible: true,
collapsed: true,
items: [
{ text: '开发教程', link: '/developers/development' },
{ text: 'envd-server', link: '/developers/kubernetes' },
]
},
{
text: '常见问题',
collapsible: true,
collapsed: true,
items: [
{ text: '为何选择 envd', link: '/faq/why' },
{ text: 'envd 和其他工具的比较', link: '/faq/comparison' },
]
},
{
text: '其他',
collapsible: true,
collapsed: true,
items: [
{ text: 'Telemetry', link: '/misc/telemetry' },
]
Expand Down
34 changes: 12 additions & 22 deletions docs/.vitepress/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -12,19 +12,18 @@ const siteHostName = 'https://envd.tensorchord.ai/'
const og = 'https://og.tensorchord.ai/api/og?title='

export default defineConfig({
lang: 'zh-CN',
lang: 'en-US',
lastUpdated: true,
locales: {
'/': {
lang: 'en-US',
title: 'envd',
description: 'AI/ML Development Environment'
},
'/zh/': {
lang: 'zh-CN',
title: 'envd',
description: 'AI/ML 开发环境'
root:{
label:'English',
lang:'en'
},
zh:{
label:'简体中文',
lang:'zh',
link:'https://zh.envd.tensorchord.ai'
}
},
title: 'envd',

Expand Down Expand Up @@ -55,22 +54,13 @@ export default defineConfig({
],

themeConfig: {
search: {
provider: 'local'
},
logo: {
light: '/logo_light.svg',
dark: '/logo_dark.svg',
},
algolia: {
appId: 'KGSWV0XY1D',
apiKey: 'a3c4e766b63fac5bee147fb9fc269cb0',
indexName: 'tensorchord',
},
localeLinks: {
text: '',
items: [
{ text: 'English', link: '/' },
{ text: '简体中文', link: 'https://zh.envd.tensorchord.ai' },
],
},

socialLinks: [
{ icon: 'github', link: 'https://github.com/tensorchord/envd' },
Expand Down
2 changes: 1 addition & 1 deletion docs/.vitepress/config/sidebar/api.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ export const apiSidebar: DefaultTheme.Sidebar = {
'/api/': [
{
text: 'envd CLI',
collapsible: true,
collapsed: true,
items: [
{ text: 'CLI references', link: '/api/cli/cli' },
]
Expand Down
14 changes: 7 additions & 7 deletions docs/.vitepress/config/sidebar/main.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ export const mainSidebar: DefaultTheme.Sidebar = {
'/':[
{
text: 'Guide',
collapsible: true,
collapsed: true,
items:[
{ text: 'Getting Started', link: '/guide/getting-started' },
{ text: 'Running Your First Environment', link:'/guide/build-envd'},
Expand All @@ -16,7 +16,7 @@ export const mainSidebar: DefaultTheme.Sidebar = {
},
{
text: 'Managing Environments',
collapsible: true,
collapsed: true,
items: [
{ text: 'Faster Build with Software Mirrors',link:'/envs/mirror' },
{ text: 'Per-user Config', link:'/envs/config'},
Expand All @@ -26,7 +26,7 @@ export const mainSidebar: DefaultTheme.Sidebar = {
},
{
text: 'envd for Your Teams',
collapsible: true,
collapsed: true,
items:[
{ text: 'Overview', link: '/teams/overview'},
{ text: 'envd on Kubernetes (Experimental)', link: '/teams/kubernetes'},
Expand All @@ -37,7 +37,7 @@ export const mainSidebar: DefaultTheme.Sidebar = {
},
{
text: 'Languages',
collapsible: true,
collapsed: true,
items:[
{ text: 'Python', link: '/lang/python' },
{ text: 'Julia', link: '/lang/julia' },
Expand All @@ -46,7 +46,7 @@ export const mainSidebar: DefaultTheme.Sidebar = {
},
{
text: 'Community',
collapsible: true,
collapsed: true,
items: [
{ text: 'Join envd Community', link: '/community/community' },
{ text: 'Contributing to envd', link: '/community/contributing' },
Expand All @@ -56,15 +56,15 @@ export const mainSidebar: DefaultTheme.Sidebar = {
},
{
text: 'for Developers',
collapsible: true,
collapsed: true,
items: [
{ text: 'Development Tutorial', link: '/developers/development' },
{ text: 'envd-server', link: '/developers/kubernetes' },
]
},
{
text: 'FAQs',
collapsible: true,
collapsed: true,
items:[
{ text: 'Why Use envd?', link: '/faq/why' },
{ text: 'envd vs. Others', link: '/faq/comparison' }
Expand Down
18 changes: 4 additions & 14 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
"name": "docs",
"version": "0.0.0",
"description": "Development Environment for Machine Learning Engineers",
"type": "module",
"scripts": {
"dev": "vitepress dev docs",
"build": "vitepress build docs",
Expand All @@ -17,21 +18,10 @@
"@types/markdown-it-footnote": "^3.0.0",
"prettier": "2.7.1",
"sitemap": "^7.1.1",
"vitepress": "1.0.0-beta.5",
"vue": "^3.2.37"
},
"pnpm": {
"peerDependencyRules": {
"ignoreMissing": [
"@types/react",
"react",
"react-dom"
]
}
"vitepress": "1.0.0-rc.32",
"vue": "^3.3.12"
},
"dependencies": {
"@algolia/client-search": "^4.9.1",
"markdown-it-footnote": "^3.0.3",
"search-insights": "^2.6.0"
"markdown-it-footnote": "^3.0.3"
}
}
Loading

0 comments on commit 0c3ddfe

Please sign in to comment.