Skip to content

Commit

Permalink
Merge pull request #172 from 142vip/feat/docs-update
Browse files Browse the repository at this point in the history
feat: 修改导航栏配置,支持图标,完善文档内容
  • Loading branch information
微信公众号:储凡 authored Sep 23, 2024
2 parents e4b010b + 9412880 commit f63a503
Show file tree
Hide file tree
Showing 9 changed files with 108 additions and 102 deletions.
28 changes: 14 additions & 14 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,14 @@ All notable changes to this project will be documented in this file. See [Conven

### ✨ Features

- 增加externalLinkIcon配置,不显示外部链接图标 &nbsp;-&nbsp; by **chufan** [<samp>(b1602)</samp>](https://github.com/142vip/JavaScriptCollection/commit/b160234)
- 移除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)
- 增加`externalLinkIcon`配置,不显示外部链接图标 &nbsp;-&nbsp; by **chufan** [<samp>(b1602)</samp>](https://github.com/142vip/JavaScriptCollection/commit/b160234)
- 移除`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)
- 使用`@142vip/fairy-cli`模块,优化`clean`命令 &nbsp;-&nbsp; by **chufan** [<samp>(2027b)</samp>](https://github.com/142vip/JavaScriptCollection/commit/2027b1a)
- `pnpm`版本锁定`9.6.0`,增加`only-allow`配置约束`pnpm` &nbsp;-&nbsp; by **chufan** [<samp>(038f1)</samp>](https://github.com/142vip/JavaScriptCollection/commit/038f1b7)
- 升级`@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)
- 配置`release`命令,升级`@142vip/fairy-cli`模块,打通整个发布工作流 &nbsp;-&nbsp; by **chufan** [<samp>(4a7de)</samp>](https://github.com/142vip/JavaScriptCollection/commit/4a7def8)
- 移除`exec`脚本执行器,修改`bundle`脚本逻辑 &nbsp;-&nbsp; by **chufan** [<samp>(05f7f)</samp>](https://github.com/142vip/JavaScriptCollection/commit/05f7fa1)
- **Github Actions**:
- **GitHub Actions**:
- 移除流水线下载依赖时的`registry-url`配置 &nbsp;-&nbsp; by **chufan** [<samp>(a0dd6)</samp>](https://github.com/142vip/JavaScriptCollection/commit/a0dd623)

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

### 🐛 Bug Fixes

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

**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)**
Expand All @@ -35,7 +35,7 @@ All notable changes to this project will be documented in this file. See [Conven

### 🐛 Bug Fixes

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

**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)**

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

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

### 🐛 Bug Fixes

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

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

**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)**

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

- 关闭自动生成README目录配置,避免构建时覆盖和路径导航问题 &nbsp;-&nbsp; by **chufan** [<samp>(b3549)</samp>](https://github.com/142vip/JavaScriptCollection/commit/b3549ff)
- 更新release脚本,使用bumpx命令生成CHANGELOG文档 &nbsp;-&nbsp; by **chufan** [<samp>(54f7b)</samp>](https://github.com/142vip/JavaScriptCollection/commit/54f7b51)
- 删除dev脚本,脚本逻辑 &nbsp;-&nbsp; by **chufan** [<samp>(78795)</samp>](https://github.com/142vip/JavaScriptCollection/commit/78795c3)
- 删除deploy和docker脚本,备份对应逻辑 &nbsp;-&nbsp; by **chufan** [<samp>(2cdc5)</samp>](https://github.com/142vip/JavaScriptCollection/commit/2cdc560)
- 更新`release`脚本,使用`bumpx`命令生成`CHANGELOG`文档 &nbsp;-&nbsp; by **chufan** [<samp>(54f7b)</samp>](https://github.com/142vip/JavaScriptCollection/commit/54f7b51)
- 删除`dev`脚本,脚本逻辑 &nbsp;-&nbsp; by **chufan** [<samp>(78795)</samp>](https://github.com/142vip/JavaScriptCollection/commit/78795c3)
- 删除`deploy``docker`脚本,备份对应逻辑 &nbsp;-&nbsp; by **chufan** [<samp>(2cdc5)</samp>](https://github.com/142vip/JavaScriptCollection/commit/2cdc560)
- 更换阿里云镜像地址 &nbsp;-&nbsp; by **chufan** [<samp>(be2e5)</samp>](https://github.com/142vip/JavaScriptCollection/commit/be2e584)
- 移除markdown-cli模块,采用prettier校验文档格式 &nbsp;-&nbsp; by **chufan** [<samp>(5a2b2)</samp>](https://github.com/142vip/JavaScriptCollection/commit/5a2b23c)
- 更换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)
- 移除`markdown-cli`模块,采用`prettier`校验文档格式 &nbsp;-&nbsp; by **chufan** [<samp>(5a2b2)</samp>](https://github.com/142vip/JavaScriptCollection/commit/5a2b23c)
- 更换`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)

### 🔥 Performance

Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -521,7 +521,7 @@ Nuxt.js是在vue框架上进行封装的,主要是用来解决单体页面的
## 趋势

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

## 联系作者
Expand Down
4 changes: 2 additions & 2 deletions docs/.vuepress/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# vuepress 目录规范

- styles 目录固定
- public 目录固定
- `styles` 目录固定
- `public` 目录固定
2 changes: 2 additions & 0 deletions docs/.vuepress/theme/constant.ts
Original file line number Diff line number Diff line change
Expand Up @@ -91,3 +91,5 @@ export const NotFoundMsgList = [
'天灰灰会不会,让我忘了你是谁,累不累睡不睡,单影无人相依偎,夜越黑梦违背,有谁肯安慰,我的世界将被摧毁也许颓废也是另一种美。',
'我知道你我都没有错,只是忘了怎么退后,信誓旦旦给的承诺,全被时间扑了空。我知道我们都没有错,只是放手会比较好过,最美的爱情回忆里待续。',
]

export const RepoAddress = 'https://github.com/142vip/JavaScriptCollection'
70 changes: 38 additions & 32 deletions docs/.vuepress/theme/navbar.ts
Original file line number Diff line number Diff line change
@@ -1,72 +1,78 @@
import { navbar } from 'vuepress-theme-hope'
import { soloAlgorithmSidebar } from '../../solo-algorithm/solo-algorithm.sidebar'
import { RepoAddress } from './constant'

export default navbar([
{
text: '首页',
text: '🌐 首页',
link: '/',
},
{
text: 'SOLO算法',
text: '🧠 SOLO算法',
children: soloAlgorithmSidebar,
},
{
text: 'Battle面试官',
text: '💡 Battle面试官',
link: '/battle-interview/',
},
{
text: '前端工程化',
link: '/front-end/',
},
{
text: '后端开发',
link: '/server-end/',
},
{
text: '微服务',
link: '/microservice/',
},
{
text: '开发技巧',
link: '/develop-skill/',
text: '💻 全栈开发',
children: [
{
text: '👩🏻‍💻 前端',
link: '/front-end/',
},
{
text: '👨🏻‍💻 后端',
link: '/server-end/',
},
{
text: '💫 开发技巧',
link: '/develop-skill/',
},
{
text: '🕸️ 微服务架构',
link: '/microservice/',
},
],
},
{
text: '读书整理',
text: '📖 读书整理',
link: '/read-books/',
},
{
text: '了解更多',
text: '👉 了解更多',
children: [
{
text: '变更记录',
text: '📄 更新日志',
link: '/changelog',
},
{
text: '网站动态',
text: '📣 网站动态',
link: '/big-event-history',
},
{
text: '自媒体',
text: '外链',
children: [
{
text: '公众号文章',
link: '/wechat-list',
text: '🎉 历史版本',
link: `${RepoAddress}/releases`,
},
{
text: '🎯 开发计划',
link: 'https://142vip-cn.feishu.cn/share/base/view/shrcnxtFKV2JfBZbqFh0GUxzTOg',
},
],
},
{
text: '外链',
children: [
{
text: '常用网站',
text: '🔗 技术&平台',
link: '/frequent-site-link',
},
{
text: 'RoadMap计划',
link: 'https://142vip-cn.feishu.cn/share/base/view/shrcnxtFKV2JfBZbqFh0GUxzTOg',
text: '💥 公众号文章',
link: '/wechat-list',
},
],
},

],
},
])
80 changes: 38 additions & 42 deletions docs/.vuepress/theme/theme.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { hopeTheme } from 'vuepress-theme-hope'
import { markdownImagePlugin } from '@vuepress/plugin-markdown-image'
import { AUTHOR_INFO, COPYRIGHT, FOOTER_HTML_INFO } from './constant'
import { AUTHOR_INFO, COPYRIGHT, FOOTER_HTML_INFO, RepoAddress } from './constant'
import { i18n, searchProCNLocals } from './i18n'
import navbar from './navbar'
import sidebar from './sidebar'
Expand All @@ -14,7 +14,7 @@ export const themeConfig = {
locales: i18n,
// navbarIcon: false,
// 禁用深色模式
darkmode: 'disable',
darkmode: 'toggle',
// 支持全屏
// fullscreen: true,
// 纯净模式
Expand All @@ -30,16 +30,26 @@ export const themeConfig = {
navbarLayout: {
start: ['Brand'],
center: [],
end: ['Links', 'Language', 'Outlook', 'Search', 'Repo'],
end: ['Links', 'Language', 'Search', 'Outlook', 'Repo'],
},
sidebar,
pageInfo: ['Author', 'Original', 'Date', 'Category', 'Tag', 'ReadingTime'],
// 主题布局选项
docsRepo: 'https://github.com/142vip/JavaScriptCollection',
docsRepo: RepoAddress,
docsDir: 'docs',
docsBranch: 'main',
repo: 'https://github.com/142vip/JavaScriptCollection.git',

docsBranch: 'next',
repo: '142vip/JavaScriptCollection',
repoLabel: 'GitHub',
// 是否在导航栏内显示仓库链接,默认为 `true`
repoDisplay: true,
// 设置页脚
displayFooter: true,
footer: FOOTER_HTML_INFO,
copyright: COPYRIGHT,
// 主题色选择器
themeColor: true,
// 是否显示外部链接图标
externalLinkIcon: false,
// 博客配置
// blog: {
// name: '测试',
Expand All @@ -53,22 +63,33 @@ export const themeConfig = {
// "BiliBili": "https://space.bilibili.com/350937042?spm_id_from=333.1007.0.0"
// }
// },
// 设置页脚
displayFooter: true,
footer: FOOTER_HTML_INFO,
copyright: COPYRIGHT,
// 主题色选择器
themeColor: true,

// 是否显示外部链接图标
externalLinkIcon: false,

plugins: {
// comment:{
// provider: "Artalk",
// server:"https://test.142vip.cn/",
// site:'JavaScriptCollection',
// },
// 公告 参考:https://theme-hope.vuejs.press/zh/guide/feature/notice.html
// notice: [
// {
// path: '/',
// title: '在线浏览',
// content: '网站无法访问时,建议通过科学上网访问备用网络',
// actions: [
// {
// text: '尝鲜版',
// link: 'https://142vip.github.io/JavaScriptCollection',
// type: 'default',
// },
// {
// text: '稳定版',
// link: 'https://code.142vip.cn',
// type: 'primary',
// },
// ],
// fullscreen: false,
// },
// ],
readingTime: {
wordPerMinute: 100,
},
Expand Down Expand Up @@ -117,8 +138,6 @@ export const themeConfig = {
vuePlayground: true,
// 文件导入,配置别名
include: true,
// 容器
// container: true,
// mermaid
mermaid: true,
// 自定义对齐
Expand All @@ -141,29 +160,6 @@ export const themeConfig = {
'Share',
'XiGua',
],
rootComponents: {
// 公告 参考:https://plugin-components.vuejs.press/zh/guide/notice.html
// notice: [
// {
// path: "/",
// title: "在线浏览",
// content: "网站无法访问时,建议通过科学上网访问备用网络",
// actions: [
// {
// text: "尝鲜版",
// link: "https://142vip.github.io/JavaScriptCollection",
// type: "default",
// },
// {
// text: "稳定版",
// link: "https://code.142vip.cn",
// type: "primary",
// },
// ],
// fullscreen: false,
// },
// ],
},
},
searchPro: {
// 参考:https://plugin-search-pro.vuejs.press/zh/config.html#locales
Expand Down
10 changes: 6 additions & 4 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,10 @@ heroAlt: 屈身守份 以待天时
heroText: JavaScriptCollection
tagline: 【理论+实战】保姆级成长笔记,持续更新...
actions:
- text: 快速开刷
- text: 快速开刷 🔥
link: /quick-start.md
type: primary
- text: 工作机会💡
- text: 工作机会 🏆
link: /job-chance/job-poster-bytedance.md
type: secondary
# - text: 公众号文章💡
Expand Down Expand Up @@ -49,8 +49,10 @@ features:

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

- \*下面指令默认你已经安装[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)
等环境,并对此有一定了解!\*\*
-

\*下面指令默认你已经安装[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)
等环境,并对此有一定了解!\*\*

::: code-tabs#shell
@tab PNPM(推荐)
Expand Down
2 changes: 1 addition & 1 deletion docs/quick-start.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: 快速开始
permalink: /quick-start.html
headerDepth: 2
headerDepth: 1
sidebar: false
---

Expand Down
Loading

0 comments on commit f63a503

Please sign in to comment.