Skip to content

Commit f63a503

Browse files
author
微信公众号：储凡
authored
Merge pull request #172 from 142vip/feat/docs-update
feat: 修改导航栏配置，支持图标，完善文档内容
2 parents e4b010b + 9412880 commit f63a503

File tree

9 files changed

+108
-102
lines changed

9 files changed

+108
-102
lines changed

‎CHANGELOG.md

+14-14
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,14 @@ All notable changes to this project will be documented in this file. See [Conven
88

99
### ✨ Features
1010

11-
- 增加externalLinkIcon配置，不显示外部链接图标 &nbsp;-&nbsp; by **chufan** [<samp>(b1602)</samp>](https://github.com/142vip/JavaScriptCollection/commit/b160234)
12-
- 移除bumpp等用于发布功能的模块，简化release脚本 &nbsp;-&nbsp; by **微信公众号：储凡** and **chufan** in https://github.com/142vip/JavaScriptCollection/issues/153 [<samp>(2e64d)</samp>](https://github.com/142vip/JavaScriptCollection/commit/2e64d8c)
11+
- 增加`externalLinkIcon`配置，不显示外部链接图标 &nbsp;-&nbsp; by **chufan** [<samp>(b1602)</samp>](https://github.com/142vip/JavaScriptCollection/commit/b160234)
12+
- 移除`bumpp`等用于发布功能的模块，简化`release`脚本 &nbsp;-&nbsp; by **微信公众号：储凡** and **chufan** in https://github.com/142vip/JavaScriptCollection/issues/153 [<samp>(2e64d)</samp>](https://github.com/142vip/JavaScriptCollection/commit/2e64d8c)
1313
- 使用`@142vip/fairy-cli`模块，优化`clean`命令 &nbsp;-&nbsp; by **chufan** [<samp>(2027b)</samp>](https://github.com/142vip/JavaScriptCollection/commit/2027b1a)
1414
- `pnpm`版本锁定`9.6.0`，增加`only-allow`配置约束`pnpm` &nbsp;-&nbsp; by **chufan** [<samp>(038f1)</samp>](https://github.com/142vip/JavaScriptCollection/commit/038f1b7)
1515
- 升级`@antfu/eslint-config`到最新版本，新增`lint`相关命令，删除重复的`lint`脚本 &nbsp;-&nbsp; by **微信公众号：储凡** and **chufan** in https://github.com/142vip/JavaScriptCollection/issues/159 [<samp>(c45a0)</samp>](https://github.com/142vip/JavaScriptCollection/commit/c45a087)
1616
- 配置`release`命令,升级`@142vip/fairy-cli`模块，打通整个发布工作流 &nbsp;-&nbsp; by **chufan** [<samp>(4a7de)</samp>](https://github.com/142vip/JavaScriptCollection/commit/4a7def8)
1717
- 移除`exec`脚本执行器，修改`bundle`脚本逻辑 &nbsp;-&nbsp; by **chufan** [<samp>(05f7f)</samp>](https://github.com/142vip/JavaScriptCollection/commit/05f7fa1)
18-
- **Github Actions**:
18+
- **GitHub Actions**:
1919
- 移除流水线下载依赖时的`registry-url`配置 &nbsp;-&nbsp; by **chufan** [<samp>(a0dd6)</samp>](https://github.com/142vip/JavaScriptCollection/commit/a0dd623)
2020

2121
### 🔥 Performance
@@ -25,8 +25,8 @@ All notable changes to this project will be documented in this file. See [Conven
2525

2626
### 🐛 Bug Fixes
2727

28-
- 使用eslint@8.55.0版本，修复IDEA校验规则报错 &nbsp;-&nbsp; by **chufan** [<samp>(3983a)</samp>](https://github.com/142vip/JavaScriptCollection/commit/3983aa5)
29-
- 修复文档、代码的Eslint校验错误 &nbsp;-&nbsp; by **微信公众号：储凡** and **chufan** in https://github.com/142vip/JavaScriptCollection/issues/154 [<samp>(7e54c)</samp>](https://github.com/142vip/JavaScriptCollection/commit/7e54cfd)
28+
- 使用`eslint@8.55.0`版本，修复`IDEA`校验规则报错 &nbsp;-&nbsp; by **chufan** [<samp>(3983a)</samp>](https://github.com/142vip/JavaScriptCollection/commit/3983aa5)
29+
- 修复文档、代码的`Eslint`校验错误 &nbsp;-&nbsp; by **微信公众号：储凡** and **chufan** in https://github.com/142vip/JavaScriptCollection/issues/154 [<samp>(7e54c)</samp>](https://github.com/142vip/JavaScriptCollection/commit/7e54cfd)
3030
- 升级`express`模块到`4.21.0`版本，解决模块安全告警 &nbsp;-&nbsp; by **chufan** [<samp>(5720d)</samp>](https://github.com/142vip/JavaScriptCollection/commit/5720dbb)
3131

3232
**Release New Version v0.0.2-alpha.18 [👉 View Changes On GitHub](https://github.com/142vip/JavaScriptCollection/compare/v0.0.2-alpha.17...v0.0.2-alpha.18)**
@@ -35,7 +35,7 @@ All notable changes to this project will be documented in this file. See [Conven
3535

3636
### 🐛 Bug Fixes
3737

38-
- 修复依赖异常，支持eslint校验 &nbsp;-&nbsp; by **chufan** [<samp>(6daed)</samp>](https://github.com/142vip/JavaScriptCollection/commit/6daed76)
38+
- 修复依赖异常，支持`eslint`校验 &nbsp;-&nbsp; by **chufan** [<samp>(6daed)</samp>](https://github.com/142vip/JavaScriptCollection/commit/6daed76)
3939

4040
**Release New Version v0.0.2-alpha.17 [👉 View Changes On GitHub](https://github.com/142vip/JavaScriptCollection/compare/v0.0.2-alpha.16...v0.0.2-alpha.17)**
4141

@@ -45,7 +45,7 @@ All notable changes to this project will be documented in this file. See [Conven
4545

4646
- 调整导航栏，对文档排版和显示做了些优化 &nbsp;-&nbsp; by **chufan** [<samp>(842f3)</samp>](https://github.com/142vip/JavaScriptCollection/commit/842f3d1)
4747
- 全局搜索框支持中文提示 &nbsp;-&nbsp; by **chufan** [<samp>(4a883)</samp>](https://github.com/142vip/JavaScriptCollection/commit/4a883ac)
48-
- Eslint回退到8.55.0版本，增加monorepo配置管理code模块中的依赖。 &nbsp;-&nbsp; by **chufan** [<samp>(28873)</samp>](https://github.com/142vip/JavaScriptCollection/commit/28873aa)
48+
- `Eslint`回退到`8.55.0`版本，增加`monorepo`配置管理`code`模块中的依赖。 &nbsp;-&nbsp; by **chufan** [<samp>(28873)</samp>](https://github.com/142vip/JavaScriptCollection/commit/28873aa)
4949

5050
### 🐛 Bug Fixes
5151

@@ -59,8 +59,8 @@ All notable changes to this project will be documented in this file. See [Conven
5959
### 🐛 Bug Fixes
6060

6161
- **Github Actions**:
62-
- 修复Release流水线异常 &nbsp;-&nbsp; by **chufan** [<samp>(d5226)</samp>](https://github.com/142vip/JavaScriptCollection/commit/d5226de)
63-
- 关闭Docker镜像构建 &nbsp;-&nbsp; by **chufan** [<samp>(74884)</samp>](https://github.com/142vip/JavaScriptCollection/commit/7488413)
62+
- 修复`Release`流水线异常 &nbsp;-&nbsp; by **chufan** [<samp>(d5226)</samp>](https://github.com/142vip/JavaScriptCollection/commit/d5226de)
63+
- 关闭`Docker`镜像构建 &nbsp;-&nbsp; by **chufan** [<samp>(74884)</samp>](https://github.com/142vip/JavaScriptCollection/commit/7488413)
6464

6565
**Release New Version v0.0.2-alpha.15 [👉 View Changes On GitHub](https://github.com/142vip/JavaScriptCollection/compare/v0.0.2-alpha.14...v0.0.2-alpha.15)**
6666

@@ -69,12 +69,12 @@ All notable changes to this project will be documented in this file. See [Conven
6969
### ✨ Features
7070

7171
- 关闭自动生成README目录配置，避免构建时覆盖和路径导航问题 &nbsp;-&nbsp; by **chufan** [<samp>(b3549)</samp>](https://github.com/142vip/JavaScriptCollection/commit/b3549ff)
72-
- 更新release脚本，使用bumpx命令生成CHANGELOG文档 &nbsp;-&nbsp; by **chufan** [<samp>(54f7b)</samp>](https://github.com/142vip/JavaScriptCollection/commit/54f7b51)
73-
- 删除dev脚本，脚本逻辑 &nbsp;-&nbsp; by **chufan** [<samp>(78795)</samp>](https://github.com/142vip/JavaScriptCollection/commit/78795c3)
74-
- 删除deploy和docker脚本，备份对应逻辑 &nbsp;-&nbsp; by **chufan** [<samp>(2cdc5)</samp>](https://github.com/142vip/JavaScriptCollection/commit/2cdc560)
72+
- 更新`release`脚本，使用`bumpx`命令生成`CHANGELOG`文档 &nbsp;-&nbsp; by **chufan** [<samp>(54f7b)</samp>](https://github.com/142vip/JavaScriptCollection/commit/54f7b51)
73+
- 删除`dev`脚本，脚本逻辑 &nbsp;-&nbsp; by **chufan** [<samp>(78795)</samp>](https://github.com/142vip/JavaScriptCollection/commit/78795c3)
74+
- 删除`deploy`和`docker`脚本，备份对应逻辑 &nbsp;-&nbsp; by **chufan** [<samp>(2cdc5)</samp>](https://github.com/142vip/JavaScriptCollection/commit/2cdc560)
7575
- 更换阿里云镜像地址 &nbsp;-&nbsp; by **chufan** [<samp>(be2e5)</samp>](https://github.com/142vip/JavaScriptCollection/commit/be2e584)
76-
- 移除markdown-cli模块，采用prettier校验文档格式 &nbsp;-&nbsp; by **chufan** [<samp>(5a2b2)</samp>](https://github.com/142vip/JavaScriptCollection/commit/5a2b23c)
77-
- 更换github pages部署方式，支持actions部署 &nbsp;-&nbsp; by **142vip.cn** in https://github.com/142vip/JavaScriptCollection/issues/144 [<samp>(7afb3)</samp>](https://github.com/142vip/JavaScriptCollection/commit/7afb312)
76+
- 移除`markdown-cli`模块，采用`prettier`校验文档格式 &nbsp;-&nbsp; by **chufan** [<samp>(5a2b2)</samp>](https://github.com/142vip/JavaScriptCollection/commit/5a2b23c)
77+
- 更换`github pages`部署方式，支持`actions`部署 &nbsp;-&nbsp; by **142vip.cn** in https://github.com/142vip/JavaScriptCollection/issues/144 [<samp>(7afb3)</samp>](https://github.com/142vip/JavaScriptCollection/commit/7afb312)
7878

7979
### 🔥 Performance
8080

‎README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -521,7 +521,7 @@ Nuxt.js是在vue框架上进行封装的，主要是用来解决单体页面的
521521
## 趋势
522522

523523
<div style="text-align: center" align="center">
524-
<img alt="Star History" src="https://api.star-history.com/svg?repos=142vip/JavaScriptCollection&type=Date" >
524+
<img alt="Star History Chart" src="https://api.star-history.com/svg?repos=142vip/JavaScriptCollection,142vip/core-x,142vip/408CSFamily&type=Date" />
525525
</div>
526526

527527
## 联系作者

‎docs/.vuepress/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# vuepress 目录规范
22

3-
- styles 目录固定
4-
- public 目录固定
3+
- `styles` 目录固定
4+
- `public` 目录固定

‎docs/.vuepress/theme/constant.ts

+2
Original file line numberDiff line numberDiff line change
@@ -91,3 +91,5 @@ export const NotFoundMsgList = [
9191
'天灰灰会不会，让我忘了你是谁，累不累睡不睡，单影无人相依偎，夜越黑梦违背，有谁肯安慰，我的世界将被摧毁也许颓废也是另一种美。',
9292
'我知道你我都没有错，只是忘了怎么退后，信誓旦旦给的承诺，全被时间扑了空。我知道我们都没有错，只是放手会比较好过，最美的爱情回忆里待续。',
9393
]
94+
95+
export const RepoAddress = 'https://github.com/142vip/JavaScriptCollection'

‎docs/.vuepress/theme/navbar.ts

+38-32
Original file line numberDiff line numberDiff line change
@@ -1,72 +1,78 @@
11
import { navbar } from 'vuepress-theme-hope'
22
import { soloAlgorithmSidebar } from '../../solo-algorithm/solo-algorithm.sidebar'
3+
import { RepoAddress } from './constant'
34

45
export default navbar([
56
{
6-
text: '首页',
7+
text: '🌐 首页',
78
link: '/',
89
},
910
{
10-
text: 'SOLO算法',
11+
text: '🧠 SOLO算法',
1112
children: soloAlgorithmSidebar,
1213
},
1314
{
14-
text: 'Battle面试官',
15+
text: '💡 Battle面试官',
1516
link: '/battle-interview/',
1617
},
1718
{
18-
text: '前端工程化',
19-
link: '/front-end/',
20-
},
21-
{
22-
text: '后端开发',
23-
link: '/server-end/',
24-
},
25-
{
26-
text: '微服务',
27-
link: '/microservice/',
28-
},
29-
{
30-
text: '开发技巧',
31-
link: '/develop-skill/',
19+
text: '💻 全栈开发',
20+
children: [
21+
{
22+
text: '👩🏻‍💻 前端',
23+
link: '/front-end/',
24+
},
25+
{
26+
text: '👨🏻‍💻 后端',
27+
link: '/server-end/',
28+
},
29+
{
30+
text: '💫 开发技巧',
31+
link: '/develop-skill/',
32+
},
33+
{
34+
text: '🕸️ 微服务架构',
35+
link: '/microservice/',
36+
},
37+
],
3238
},
3339
{
34-
text: '读书整理',
40+
text: '📖 读书整理',
3541
link: '/read-books/',
3642
},
3743
{
38-
text: '了解更多',
44+
text: '👉 了解更多',
3945
children: [
4046
{
41-
text: '变更记录',
47+
text: '📄 更新日志',
4248
link: '/changelog',
4349
},
4450
{
45-
text: '网站动态',
51+
text: '📣 网站动态',
4652
link: '/big-event-history',
4753
},
4854
{
49-
text: '自媒体',
55+
text: '外链',
5056
children: [
5157
{
52-
text: '公众号文章',
53-
link: '/wechat-list',
58+
text: '🎉 历史版本',
59+
link: `${RepoAddress}/releases`,
60+
},
61+
{
62+
text: '🎯 开发计划',
63+
link: 'https://142vip-cn.feishu.cn/share/base/view/shrcnxtFKV2JfBZbqFh0GUxzTOg',
5464
},
55-
],
56-
},
57-
{
58-
text: '外链',
59-
children: [
6065
{
61-
text: '常用网站',
66+
text: '🔗 技术&平台',
6267
link: '/frequent-site-link',
6368
},
6469
{
65-
text: 'RoadMap计划',
66-
link: 'https://142vip-cn.feishu.cn/share/base/view/shrcnxtFKV2JfBZbqFh0GUxzTOg',
70+
text: '💥 公众号文章',
71+
link: '/wechat-list',
6772
},
6873
],
6974
},
75+
7076
],
7177
},
7278
])

‎docs/.vuepress/theme/theme.ts

+38-42
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
import { hopeTheme } from 'vuepress-theme-hope'
22
import { markdownImagePlugin } from '@vuepress/plugin-markdown-image'
3-
import { AUTHOR_INFO, COPYRIGHT, FOOTER_HTML_INFO } from './constant'
3+
import { AUTHOR_INFO, COPYRIGHT, FOOTER_HTML_INFO, RepoAddress } from './constant'
44
import { i18n, searchProCNLocals } from './i18n'
55
import navbar from './navbar'
66
import sidebar from './sidebar'
@@ -14,7 +14,7 @@ export const themeConfig = {
1414
locales: i18n,
1515
// navbarIcon: false,
1616
// 禁用深色模式
17-
darkmode: 'disable',
17+
darkmode: 'toggle',
1818
// 支持全屏
1919
// fullscreen: true,
2020
// 纯净模式
@@ -30,16 +30,26 @@ export const themeConfig = {
3030
navbarLayout: {
3131
start: ['Brand'],
3232
center: [],
33-
end: ['Links', 'Language', 'Outlook', 'Search', 'Repo'],
33+
end: ['Links', 'Language', 'Search', 'Outlook', 'Repo'],
3434
},
3535
sidebar,
3636
pageInfo: ['Author', 'Original', 'Date', 'Category', 'Tag', 'ReadingTime'],
3737
// 主题布局选项
38-
docsRepo: 'https://github.com/142vip/JavaScriptCollection',
38+
docsRepo: RepoAddress,
3939
docsDir: 'docs',
40-
docsBranch: 'main',
41-
repo: 'https://github.com/142vip/JavaScriptCollection.git',
42-
40+
docsBranch: 'next',
41+
repo: '142vip/JavaScriptCollection',
42+
repoLabel: 'GitHub',
43+
// 是否在导航栏内显示仓库链接，默认为 `true`
44+
repoDisplay: true,
45+
// 设置页脚
46+
displayFooter: true,
47+
footer: FOOTER_HTML_INFO,
48+
copyright: COPYRIGHT,
49+
// 主题色选择器
50+
themeColor: true,
51+
// 是否显示外部链接图标
52+
externalLinkIcon: false,
4353
// 博客配置
4454
// blog: {
4555
// name: '测试',
@@ -53,22 +63,33 @@ export const themeConfig = {
5363
// "BiliBili": "https://space.bilibili.com/350937042?spm_id_from=333.1007.0.0"
5464
// }
5565
// },
56-
// 设置页脚
57-
displayFooter: true,
58-
footer: FOOTER_HTML_INFO,
59-
copyright: COPYRIGHT,
60-
// 主题色选择器
61-
themeColor: true,
62-
63-
// 是否显示外部链接图标
64-
externalLinkIcon: false,
65-
6666
plugins: {
6767
// comment:{
6868
// provider: "Artalk",
6969
// server:"https://test.142vip.cn/",
7070
// site:'JavaScriptCollection',
7171
// },
72+
// 公告 参考：https://theme-hope.vuejs.press/zh/guide/feature/notice.html
73+
// notice: [
74+
// {
75+
// path: '/',
76+
// title: '在线浏览',
77+
// content: '网站无法访问时，建议通过科学上网访问备用网络',
78+
// actions: [
79+
// {
80+
// text: '尝鲜版',
81+
// link: 'https://142vip.github.io/JavaScriptCollection',
82+
// type: 'default',
83+
// },
84+
// {
85+
// text: '稳定版',
86+
// link: 'https://code.142vip.cn',
87+
// type: 'primary',
88+
// },
89+
// ],
90+
// fullscreen: false,
91+
// },
92+
// ],
7293
readingTime: {
7394
wordPerMinute: 100,
7495
},
@@ -117,8 +138,6 @@ export const themeConfig = {
117138
vuePlayground: true,
118139
// 文件导入，配置别名
119140
include: true,
120-
// 容器
121-
// container: true,
122141
// mermaid
123142
mermaid: true,
124143
// 自定义对齐
@@ -141,29 +160,6 @@ export const themeConfig = {
141160
'Share',
142161
'XiGua',
143162
],
144-
rootComponents: {
145-
// 公告 参考：https://plugin-components.vuejs.press/zh/guide/notice.html
146-
// notice: [
147-
// {
148-
// path: "/",
149-
// title: "在线浏览",
150-
// content: "网站无法访问时，建议通过科学上网访问备用网络",
151-
// actions: [
152-
// {
153-
// text: "尝鲜版",
154-
// link: "https://142vip.github.io/JavaScriptCollection",
155-
// type: "default",
156-
// },
157-
// {
158-
// text: "稳定版",
159-
// link: "https://code.142vip.cn",
160-
// type: "primary",
161-
// },
162-
// ],
163-
// fullscreen: false,
164-
// },
165-
// ],
166-
},
167163
},
168164
searchPro: {
169165
// 参考：https://plugin-search-pro.vuejs.press/zh/config.html#locales

‎docs/README.md

+6-4
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,10 @@ heroAlt: 屈身守份 以待天时
55
heroText: JavaScriptCollection
66
tagline: 【理论+实战】保姆级成长笔记，持续更新...
77
actions:
8-
- text: 快速开刷 →
8+
- text: 快速开刷 🔥
99
link: /quick-start.md
1010
type: primary
11-
- text: 工作机会💡
11+
- text: 工作机会 🏆
1212
link: /job-chance/job-poster-bytedance.md
1313
type: secondary
1414
# - text: 公众号文章💡
@@ -49,8 +49,10 @@ features:
4949

5050
由于平台、网络等原因，在线浏览容易出现加载面、加载不出来等常见问题，因此非常建议在本地进行浏览、学习。
5151

52-
- \*下面指令默认你已经安装[Git](https://git-scm.com/download)、[NPM](https://www.npmjs.com/)、[PNPM](https://www.pnpm.cn/)、[Yarn](https://yarn.bootcss.com/)、[Node](http://nodejs.cn)
53-
等环境，并对此有一定了解!\*\*
52+
-
53+
54+
\*下面指令默认你已经安装[Git](https://git-scm.com/download)、[NPM](https://www.npmjs.com/)、[PNPM](https://www.pnpm.cn/)、[Yarn](https://yarn.bootcss.com/)、[Node](http://nodejs.cn)
55+
等环境，并对此有一定了解!\*\*
5456

5557
::: code-tabs#shell
5658
@tab PNPM（推荐）

‎docs/quick-start.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: 快速开始
33
permalink: /quick-start.html
4-
headerDepth: 2
4+
headerDepth: 1
55
sidebar: false
66
---
77

0 commit comments

Comments
 (0)