Skip to content

Commit 6b48bbe

Browse files
shanjinghengshanjingheng
committed
Change doc for shengwang doc.
1 parent 7693f13 commit 6b48bbe

File tree

5 files changed

+160
-160
lines changed

5 files changed

+160
-160
lines changed

‎.github/workflows/blank.yml‎

Lines changed: 56 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -1,64 +1,64 @@
1-
name: note build
2-
# 触发workflow的条件
3-
on:
4-
push:
5-
branches: ["doc-v2"]
1+
# name: note build
2+
# # 触发workflow的条件
3+
# on:
4+
# push:
5+
# branches: ['doc-v2']
66

7-
env:
8-
SERVER_PRIVATE_KEY: ${{ secrets.SERVER_PRIVATE_KEY }} # 服务器私钥
9-
SERVER_HOST: ${{ secrets.SERVER_HOST }} # 服务器IP地址
10-
SERVER_POSR: ${{ secrets.SERVER_PORT }} # 服务器端口
11-
USER_NAME: ${{ secrets.SERVER_USER_NAME }} # 服务器用户名
12-
cache-name: note
13-
TZ: Asia/Shanghai # 设置当前环境时区
7+
# env:
8+
# SERVER_PRIVATE_KEY: ${{ secrets.SERVER_PRIVATE_KEY }} # 服务器私钥
9+
# SERVER_HOST: ${{ secrets.SERVER_HOST }} # 服务器IP地址
10+
# SERVER_POSR: ${{ secrets.SERVER_PORT }} # 服务器端口
11+
# USER_NAME: ${{ secrets.SERVER_USER_NAME }} # 服务器用户名
12+
# cache-name: note
13+
# TZ: Asia/Shanghai # 设置当前环境时区
1414

15-
# jobs表示执行的一项或多项任务
16-
jobs:
17-
cache-and-install:
18-
runs-on: ubuntu-latest
19-
steps:
20-
- name: Checkout
21-
uses: actions/checkout@v3
15+
# # jobs表示执行的一项或多项任务
16+
# jobs:
17+
# cache-and-install:
18+
# runs-on: ubuntu-latest
19+
# steps:
20+
# - name: Checkout
21+
# uses: actions/checkout@v3
2222

23-
- name: Install Node.js
24-
uses: actions/setup-node@v3
25-
with:
26-
node-version: 18
23+
# - name: Install Node.js
24+
# uses: actions/setup-node@v3
25+
# with:
26+
# node-version: 18
2727

28-
- name: Run install
29-
uses: borales/actions-yarn@v4
30-
with:
31-
cmd: install
28+
# - name: Run install
29+
# uses: borales/actions-yarn@v4
30+
# with:
31+
# cmd: install
3232

33-
- name: Build production bundle
34-
uses: borales/actions-yarn@v4
35-
with:
36-
cmd: docs:build
33+
# - name: Build production bundle
34+
# uses: borales/actions-yarn@v4
35+
# with:
36+
# cmd: docs:build
3737

38-
# 上传打包资源
39-
- name: Deploy
40-
uses: easingthemes/ssh-deploy@main
41-
env:
42-
SSH_PRIVATE_KEY: ${{ secrets.SERVER_PRIVATE_KEY }}
43-
ARGS: "-rltgoDzvO --delete"
44-
SOURCE: "docs/.vuepress/dist/"
45-
REMOTE_HOST: ${{ secrets.SERVER_HOST }}
46-
REMOTE_PORT: ${{ secrets.SERVER_PORT }} -o HostKeyAlgorithms=+ssh-rsa -o PubkeyAcceptedKeyTypes=+ssh-rsa
47-
REMOTE_USER: ${{ secrets.SERVER_USER_NAME }}
48-
TARGET: /data/apps/data/docs-im-beta/ # 服务器目标路径
38+
# # 上传打包资源
39+
# - name: Deploy
40+
# uses: easingthemes/ssh-deploy@main
41+
# env:
42+
# SSH_PRIVATE_KEY: ${{ secrets.SERVER_PRIVATE_KEY }}
43+
# ARGS: '-rltgoDzvO --delete'
44+
# SOURCE: 'docs/.vuepress/dist/'
45+
# REMOTE_HOST: ${{ secrets.SERVER_HOST }}
46+
# REMOTE_PORT: ${{ secrets.SERVER_PORT }} -o HostKeyAlgorithms=+ssh-rsa -o PubkeyAcceptedKeyTypes=+ssh-rsa
47+
# REMOTE_USER: ${{ secrets.SERVER_USER_NAME }}
48+
# TARGET: /data/apps/data/docs-im-beta/ # 服务器目标路径
4949

50-
- name: CDN Refresh HTTPS
51-
uses: visionwx/ali-cdn-refresh@main
52-
with:
53-
accessKeyId: ${{ secrets.ALIYUN_CDN_ACCESS_KEY_ID }}
54-
accessKeySecret: ${{ secrets.ALIYUN_CDN_ACCESS_KEY_SECRET }}
55-
type: Directory
56-
path: https://doc.easemob.com/
50+
# - name: CDN Refresh HTTPS
51+
# uses: visionwx/ali-cdn-refresh@main
52+
# with:
53+
# accessKeyId: ${{ secrets.ALIYUN_CDN_ACCESS_KEY_ID }}
54+
# accessKeySecret: ${{ secrets.ALIYUN_CDN_ACCESS_KEY_SECRET }}
55+
# type: Directory
56+
# path: https://doc.easemob.com/
5757

58-
- name: CDN Refresh HTTP
59-
uses: visionwx/ali-cdn-refresh@main
60-
with:
61-
accessKeyId: ${{ secrets.ALIYUN_CDN_ACCESS_KEY_ID }}
62-
accessKeySecret: ${{ secrets.ALIYUN_CDN_ACCESS_KEY_SECRET }}
63-
type: Directory
64-
path: http://doc.easemob.com/
58+
# - name: CDN Refresh HTTP
59+
# uses: visionwx/ali-cdn-refresh@main
60+
# with:
61+
# accessKeyId: ${{ secrets.ALIYUN_CDN_ACCESS_KEY_ID }}
62+
# accessKeySecret: ${{ secrets.ALIYUN_CDN_ACCESS_KEY_SECRET }}
63+
# type: Directory
64+
# path: http://doc.easemob.com/

‎docs/.vuepress/config.ts‎

Lines changed: 75 additions & 75 deletions
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,9 @@ import path from 'node:path'
2525
export default defineUserConfig({
2626
base: '/',
2727
lang: 'zh-CN',
28-
title: '环信 IM 文档',
28+
title: '即时通讯',
2929
head: [['link', { rel: 'icon', href: '/logo.png' }]],
30-
description: '环信 IM 文档',
30+
description: '声网即时通讯文档',
3131
bundler: viteBundler({
3232
viteOptions: {
3333
resolve: {
@@ -56,79 +56,79 @@ export default defineUserConfig({
5656
},
5757
templateBuild: path.resolve(__dirname, './templates/index.build.html'),
5858
theme,
59-
plugins: [
60-
docsearchPlugin({
61-
appId: '5K8UTB3JVE',
62-
apiKey: 'df9e938d06f6531ce8dd8de71f907f0d',
63-
indexName: 'im-beta-easemob',
64-
searchParameters: {
65-
attributesToSnippet: [
66-
'hierarchy.lvl1:20',
67-
'hierarchy.lvl2:20',
68-
'hierarchy.lvl3:20',
69-
'hierarchy.lvl4:20',
70-
'hierarchy.lvl5:20',
71-
'hierarchy.lvl6:20',
72-
'content:50'
73-
],
74-
hitsPerPage: 50,
75-
facetFilters: [
76-
[
77-
'type:lvl0',
78-
'type:lvl1',
79-
'type:lvl2',
80-
'type:lvl3',
81-
'type:lvl4',
82-
'type:lvl5'
83-
]
84-
]
85-
},
86-
maxResultsPerGroup: 30,
87-
// transformItems: (items) => {
88-
// console.log(items)
89-
// return items.map((items) => ({ ...items, content: 'xxxxxx' }))
90-
// },
91-
placeholder: '搜索文档',
92-
translations: {
93-
button: {
94-
buttonText: '搜索',
95-
buttonAriaLabel: '搜索文档'
96-
},
97-
modal: {
98-
searchBox: {
99-
resetButtonTitle: '清除查询条件',
100-
resetButtonAriaLabel: '清除查询条件',
101-
cancelButtonText: '取消',
102-
cancelButtonAriaLabel: '取消'
103-
},
104-
startScreen: {
105-
recentSearchesTitle: '搜索历史',
106-
noRecentSearchesText: '没有搜索历史',
107-
saveRecentSearchButtonTitle: '保存至搜索历史',
108-
removeRecentSearchButtonTitle: '从搜索历史中移除',
109-
favoriteSearchesTitle: '收藏',
110-
removeFavoriteSearchButtonTitle: '从收藏中移除'
111-
},
112-
errorScreen: {
113-
titleText: '无法获取结果',
114-
helpText: '你可能需要检查你的网络连接'
115-
},
116-
footer: {
117-
selectText: '选择',
118-
navigateText: '切换',
119-
closeText: '关闭',
120-
searchByText: '搜索提供者'
121-
},
122-
noResultsScreen: {
123-
noResultsText: '无法找到相关结果',
124-
suggestedQueryText: '你可以尝试查询',
125-
reportMissingResultsText: '你认为该查询应该有结果？',
126-
reportMissingResultsLinkText: '点击反馈'
127-
}
128-
}
129-
}
130-
})
131-
],
59+
// plugins: [
60+
// docsearchPlugin({
61+
// appId: '5K8UTB3JVE',
62+
// apiKey: 'df9e938d06f6531ce8dd8de71f907f0d',
63+
// indexName: 'im-beta-easemob',
64+
// searchParameters: {
65+
// attributesToSnippet: [
66+
// 'hierarchy.lvl1:20',
67+
// 'hierarchy.lvl2:20',
68+
// 'hierarchy.lvl3:20',
69+
// 'hierarchy.lvl4:20',
70+
// 'hierarchy.lvl5:20',
71+
// 'hierarchy.lvl6:20',
72+
// 'content:50'
73+
// ],
74+
// hitsPerPage: 50,
75+
// facetFilters: [
76+
// [
77+
// 'type:lvl0',
78+
// 'type:lvl1',
79+
// 'type:lvl2',
80+
// 'type:lvl3',
81+
// 'type:lvl4',
82+
// 'type:lvl5'
83+
// ]
84+
// ]
85+
// },
86+
// maxResultsPerGroup: 30,
87+
// // transformItems: (items) => {
88+
// // console.log(items)
89+
// // return items.map((items) => ({ ...items, content: 'xxxxxx' }))
90+
// // },
91+
// placeholder: '搜索文档',
92+
// translations: {
93+
// button: {
94+
// buttonText: '搜索',
95+
// buttonAriaLabel: '搜索文档'
96+
// },
97+
// modal: {
98+
// searchBox: {
99+
// resetButtonTitle: '清除查询条件',
100+
// resetButtonAriaLabel: '清除查询条件',
101+
// cancelButtonText: '取消',
102+
// cancelButtonAriaLabel: '取消'
103+
// },
104+
// startScreen: {
105+
// recentSearchesTitle: '搜索历史',
106+
// noRecentSearchesText: '没有搜索历史',
107+
// saveRecentSearchButtonTitle: '保存至搜索历史',
108+
// removeRecentSearchButtonTitle: '从搜索历史中移除',
109+
// favoriteSearchesTitle: '收藏',
110+
// removeFavoriteSearchButtonTitle: '从收藏中移除'
111+
// },
112+
// errorScreen: {
113+
// titleText: '无法获取结果',
114+
// helpText: '你可能需要检查你的网络连接'
115+
// },
116+
// footer: {
117+
// selectText: '选择',
118+
// navigateText: '切换',
119+
// closeText: '关闭',
120+
// searchByText: '搜索提供者'
121+
// },
122+
// noResultsScreen: {
123+
// noResultsText: '无法找到相关结果',
124+
// suggestedQueryText: '你可以尝试查询',
125+
// reportMissingResultsText: '你认为该查询应该有结果？',
126+
// reportMissingResultsLinkText: '点击反馈'
127+
// }
128+
// }
129+
// }
130+
// })
131+
// ],
132132
onPrepared: async (app) => {
133133
await app.writeTemp(
134134
'pages.js',

‎docs/.vuepress/navbar/index.ts‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -246,11 +246,11 @@ export const zhNavbar = navbar([
246246
]
247247
}
248248
]
249-
},
250-
{
251-
text: '即时推送',
252-
link: '/push/push_overview.html'
253-
},
249+
}
250+
// {
251+
// text: '即时推送',
252+
// link: '/push/push_overview.html'
253+
// }
254254
// {
255255
// text: "私有部署",
256256
// children: [
@@ -264,6 +264,6 @@ export const zhNavbar = navbar([
264264
// },
265265
// ],
266266
// },
267-
{ text: '历史版本', link: 'https://docs-im.easemob.com/ccim/intro' },
268-
{ text: '有奖调研', link: 'https://doc.easemob.com/form/wjx.html' }
267+
// { text: '历史版本', link: 'https://docs-im.easemob.com/ccim/intro' },
268+
// { text: '有奖调研', link: 'https://doc.easemob.com/form/wjx.html' }
269269
])

‎docs/.vuepress/theme.ts‎

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,13 @@ interface CustomConfig {
77
}
88

99
export default hopeTheme(<ThemeOptions & CustomConfig>{
10-
hostname: 'https://doc.easemob.com/',
11-
home: '/',
10+
hostname: 'https://doc.chat.rtnsvc.com/',
11+
home: '/product/introduction.html',
1212
iconAssets: 'iconfont',
13-
logo: '/logo.png',
14-
repo: 'easemob/easemob-doc',
15-
docsBranch: 'doc-v2',
16-
docsDir: 'docs',
13+
// logo: '/logo.svg',
14+
// repo: 'easemob/easemob-doc',
15+
// docsBranch: 'doc-v2',
16+
// docsDir: 'docs',
1717
darkmode: 'disable',
1818
pure: true,
1919
contributors: false,
@@ -26,26 +26,26 @@ export default hopeTheme(<ThemeOptions & CustomConfig>{
2626
},
2727
// sidebar
2828
sidebar: zhSidebar,
29-
footer: '环信 IM 文档 Version: 1.0.0 ©️环信',
30-
displayFooter: true,
29+
// footer: '环信 IM 文档 Version: 1.0.0 ©️环信',
30+
displayFooter: false,
3131
headerDepth: 2,
3232
extra_nav: [
3333
// { text: '提交工单', link: 'https://console.easemob.com/ticket', type: 'info' },
34-
{
35-
text: '登录',
36-
link: 'https://console.easemob.com/user/login',
37-
type: 'success'
38-
},
39-
{
40-
text: '注册',
41-
link: 'https://console.easemob.com/user/register',
42-
type: 'primary'
43-
}
34+
// {
35+
// text: '登录',
36+
// link: 'https://console.easemob.com/user/login',
37+
// type: 'success'
38+
// },
39+
// {
40+
// text: '注册',
41+
// link: 'https://console.easemob.com/user/register',
42+
// type: 'primary'
43+
// }
4444
],
4545
// page meta
46-
metaLocales: {
47-
editLink: '在 GitHub 上编辑此页'
48-
},
46+
// metaLocales: {
47+
// editLink: '在 GitHub 上编辑此页'
48+
// },
4949
plugins: {
5050
mdEnhance: {
5151
container: true,

‎docs/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
home: true
2+
home: false
33
title: 导航页
44
heroText: false
55
tagline: false

0 commit comments

Comments
 (0)