Merge pull request #64 from mmdapl/feat/add-sidebar

feat: 新增变更记录文档，支持release自动生成

.versionrc.js

@@ -1,24 +1,25 @@
 // commit-and-tag-version 配置，参考：https://github.com/conventional-changelog/standard-version
-module.exports={
-  "header": "# Release history\n\nAll notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.\n\n<!-- #region recent-beta -->\n",
-  "releaseCommitMessageFormat": "chore(release): publish v{{currentTag}}",
-  "types": [
-    { "type": "feat", "section": "Features" },
-    { "type": "feature", "section": "Features" },
-    { "type": "fix", "section": "Bug Fixes" },
-    { "type": "perf", "section": "Performance Improvements" },
-    { "type": "revert", "section": "Reverts" },
-    { "type": "docs", "section": "Documentation", "hidden": true },
-    { "type": "style", "section": "Styles", "hidden": true },
-    { "type": "chore", "section": "Miscellaneous Chores", "hidden": true },
-    { "type": "refactor", "section": "Code Refactoring", "hidden": true },
-    { "type": "test", "section": "Tests", "hidden": true },
-    { "type": "build", "section": "Build System", "hidden": true },
-    { "type": "ci", "section": "Continuous Integration", "hidden": true }
+// 配置参考：https://github.com/conventional-changelog/conventional-changelog-config-spec/blob/master/versions/2.2.0/README.md
+module.exports = {
+  header: '# Release history\n\nAll notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.\n\n<!-- #region recent-alpha -->\n',
+  releaseCommitMessageFormat: 'chore(release): publish v{{currentTag}}',
+  types: [
+    {type: 'feat', section: 'Features'},
+    {type: 'feature', section: 'Features'},
+    {type: 'fix', section: 'Bug Fixes'},
+    {type: 'perf', section: 'Performance Improvements'},
+    {type: 'revert', section: 'Reverts'},
+    {type: 'docs', section: 'Documentation', hidden: true},
+    {type: 'style', section: 'Styles', hidden: true},
+    {type: 'chore', section: 'Miscellaneous Chores', hidden: true},
+    {type: 'refactor', section: 'Code Refactoring', hidden: true},
+    {type: 'test', section: 'Tests', hidden: true},
+    {type: 'build', section: 'Build System', hidden: true},
+    {type: 'ci', section: 'Continuous Integration', hidden: true}
   ],
-    "skip": {
-    "bump": true,
-      "commit": true,
-      "tag": true
+  skip: {
+    bump: true,
+    commit: true,
+    tag: true
   }
-}
+}

CHANGELOG.md

@@ -2,7 +2,7 @@
 
 All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
-<!-- #region recent-beta -->
+<!-- #region recent-alpha -->
 
 ## [0.0.2-alpha.2](https://github.com/mmdapl/JavaScriptCollection/compare/v0.0.2-alpha.1...v0.0.2-alpha.2) (2023-09-12)
 
@@ -22,15 +22,11 @@ All notable changes to this project will be documented in this file. See [Conven
 
 ### Features
 
-* add docs ([11ee1d7](https://github.com/mmdapl/JavaScriptCollection/commit/11ee1d702a608c96a85153c8f6a8005c9abecf39))
 * add workflow to deploy ([68c8044](https://github.com/mmdapl/JavaScriptCollection/commit/68c8044079c75b2b7926e633b1c06ca7ff57acc3))
 * **algorithm:** 算法文档更新，侧边栏优化 ([80f08f6](https://github.com/mmdapl/JavaScriptCollection/commit/80f08f66dd98e3a511f6ac48f1f55bca8bbc6655))
 * build-proxy image ([e460747](https://github.com/mmdapl/JavaScriptCollection/commit/e460747d5719490c659a6b015418a4daa7179d89))
-* **ci:** add code-ci for eslint ([c8b91aa](https://github.com/mmdapl/JavaScriptCollection/commit/c8b91aa5fe3b50411f65d878c89193cb64f1a7bf))
 * ci回滚 ([7f9f9b4](https://github.com/mmdapl/JavaScriptCollection/commit/7f9f9b46bd0738bc2ecd2c676b6c073e2c1a9c3f))
-* **ci:** 支持master分之部署 ([b60319c](https://github.com/mmdapl/JavaScriptCollection/commit/b60319cba8049d0488d4e32a60f1e3c9af1d9a45))
 * ci流程优化，修复部分脚本异常 ([8e50abf](https://github.com/mmdapl/JavaScriptCollection/commit/8e50abfc505a36be3f31d5ac4e17dceb72a80981))
-* delete ([27d568a](https://github.com/mmdapl/JavaScriptCollection/commit/27d568a25a664cde7ab591883693aca28bd7055a))
 * delete grpc code ([d7ef3fc](https://github.com/mmdapl/JavaScriptCollection/commit/d7ef3fcf382efd7053ed4d821b78fe0735f11c4a))
 * deploy esc ([0d90d30](https://github.com/mmdapl/JavaScriptCollection/commit/0d90d30268ca823ac2f4c5afedd25ef4add669da))
 * docker-compose文档 ([7b2eb76](https://github.com/mmdapl/JavaScriptCollection/commit/7b2eb762f69089469c3e3ea74b5bcc4fd9b45d42))
@@ -42,21 +38,15 @@ All notable changes to this project will be documented in this file. See [Conven
 * esc ci update ([3aec5cf](https://github.com/mmdapl/JavaScriptCollection/commit/3aec5cfd0cc40941bf1975d9204f72234b59ec22))
 * esc description update ([8e07aa3](https://github.com/mmdapl/JavaScriptCollection/commit/8e07aa371d1366789360c0dd5fbcca47f3ae3c75))
 * **eslint:** husky代码校验，eslint规则配置 ([9e2f9bf](https://github.com/mmdapl/JavaScriptCollection/commit/9e2f9bfeea919317eb7f4a4a8e9eb41474976aa8))
-* just a job ([11bd00a](https://github.com/mmdapl/JavaScriptCollection/commit/11bd00a4ca3712fda698bdd22f83417ccabe50f7))
 * reset git branch ([450875e](https://github.com/mmdapl/JavaScriptCollection/commit/450875ef3ee9a626bf8a0617383cd5fc401a2395))
 * **scripts:** 脚本优化，package.json调整 ([accd1d1](https://github.com/mmdapl/JavaScriptCollection/commit/accd1d19f0a0e57176557babfb6e416d21a3949d))
-* **scripts:** 脚本优化，项目结构调整 ([d0de025](https://github.com/mmdapl/JavaScriptCollection/commit/d0de025c5e41540b1ef00e7bb6230324ee596dc9))
 * shell相关代码初始化 ([3c0e1d6](https://github.com/mmdapl/JavaScriptCollection/commit/3c0e1d697c7a99d155e1b369da10b2d8d1850caf))
 * ssh-master ([6e56d68](https://github.com/mmdapl/JavaScriptCollection/commit/6e56d68b5be1e8ac912bf047cb8a7fefc105be2d))
-* update ([871d031](https://github.com/mmdapl/JavaScriptCollection/commit/871d0311a78bcf3e24f9fbe436f88318ccc72f0c))
-* update /service_env/ ([0434970](https://github.com/mmdapl/JavaScriptCollection/commit/0434970eb89836cd3a0db685ff738a324f67326b))
-* update ci ([f01ca69](https://github.com/mmdapl/JavaScriptCollection/commit/f01ca6903e5bf992598f62a636269489b0bfee95))
 * update ci yaml ([e7e33f5](https://github.com/mmdapl/JavaScriptCollection/commit/e7e33f56ad20820ced703567690c84bc4a9070c6))
 * update-desc ([185af9d](https://github.com/mmdapl/JavaScriptCollection/commit/185af9db8762d9cd394bad944a66e6a2d672afee))
 * **vercel:** vercel 统计相关配置 ([fe5f02e](https://github.com/mmdapl/JavaScriptCollection/commit/fe5f02ed5b921b26105233653ef66d9eef932430))
 * 优化js代码，新增链表相关刷题文档 ([d99044f](https://github.com/mmdapl/JavaScriptCollection/commit/d99044f1ffc643b14b8c41cc63f6e9bab105b71b))
 * 优化导航栏配置 ([3776e49](https://github.com/mmdapl/JavaScriptCollection/commit/3776e49ffb1f2c1813c5f96e552649925183444c))
-* 侧边栏配置修复 ([2047269](https://github.com/mmdapl/JavaScriptCollection/commit/204726974bd717664c67c1f08ba848f4b2bde897))
 * 侧边栏配置更新 ([88b70aa](https://github.com/mmdapl/JavaScriptCollection/commit/88b70aad92b365b2bce92062b867b6edb1e377cc))
 * 修复 netlify平台部署 ([0cf2830](https://github.com/mmdapl/JavaScriptCollection/commit/0cf2830fe4d00de0733eff89a970886d29475d70))
 * 修改 基础配置更新 ([c721ab1](https://github.com/mmdapl/JavaScriptCollection/commit/c721ab11f36fcd4af7dd02409169f0639fff3ba6))
@@ -68,7 +58,6 @@ All notable changes to this project will be documented in this file. See [Conven
 * 修改侧边栏结构，优化镜像构建脚本 ([7839f95](https://github.com/mmdapl/JavaScriptCollection/commit/7839f95e11e93f8d3c48a7c2a33919d2d1683000))
 * 修改导航栏结构，添加文档 ([9bbe9ae](https://github.com/mmdapl/JavaScriptCollection/commit/9bbe9aed4b9885f927f4df8c390570e1fc17b3fb))
 * 修改部署脚本及配置 ([5474059](https://github.com/mmdapl/JavaScriptCollection/commit/54740596dfa0e7391c9a464e9884138425ce6aab))
-* 修改配置 ([08ae5de](https://github.com/mmdapl/JavaScriptCollection/commit/08ae5debabf2a6ca4d3a37fe1ff6645b4e3e6ab0))
 * 修改镜像版本，删除无用脚本 ([2054593](https://github.com/mmdapl/JavaScriptCollection/commit/2054593e3031892ad5b99445622c4bc1ec592967))
 * 升级eslint版本，修改侧边栏 ([3dca375](https://github.com/mmdapl/JavaScriptCollection/commit/3dca3756c14b238320cee914ac789facbd9881dc))
 * 忽略文件配置修改 ([3251a00](https://github.com/mmdapl/JavaScriptCollection/commit/3251a0093db0631bbc7c8859ac7027d914e588b6))
@@ -79,8 +68,6 @@ All notable changes to this project will be documented in this file. See [Conven
 * 新增linux基础指令文档 ([88a9f2c](https://github.com/mmdapl/JavaScriptCollection/commit/88a9f2c0ec40e957e8818c96a8c75985de73369c))
 * 新增PROXY_DOMAIN环境变量配置，支持base转化 ([5ea2e5d](https://github.com/mmdapl/JavaScriptCollection/commit/5ea2e5d3537e3ded6a57aff83bdae985316c7f3a))
 * 新增redis主从集群文档 ([feebfbe](https://github.com/mmdapl/JavaScriptCollection/commit/feebfbea121c2bbacdaef751178a042cbbb1f6a5))
-* 新增redis相关文章 ([f929360](https://github.com/mmdapl/JavaScriptCollection/commit/f9293602067827a5e02997133202696389f791ac))
-* 新增一些文档 ([95f8f86](https://github.com/mmdapl/JavaScriptCollection/commit/95f8f862bb563c18a063f6306ad96326c531b33d))
 * 新增一些文档，优化配置 ([1c24993](https://github.com/mmdapl/JavaScriptCollection/commit/1c24993ec78cd87abc927317af31fe0064b262c0))
 * 新增文档,优化navbar导航栏 ([983b783](https://github.com/mmdapl/JavaScriptCollection/commit/983b7839e2be4588b1ac680a0f2692d1f7343b88))
 * 新增算法文档 ([fc602dd](https://github.com/mmdapl/JavaScriptCollection/commit/fc602ddb27847a43e2668a40e5e516df8674819a))
@@ -111,3 +98,5 @@ All notable changes to this project will be documented in this file. See [Conven
 ### Performance Improvements
 
 * **pnpm:** 升级模块 ([b283402](https://github.com/mmdapl/JavaScriptCollection/commit/b2834025a4de2162d25f7694be75585dd4244ef5))
+
+<!-- #endregion recent-alpha -->

docs/.vuepress/config/theme.config.ts

@@ -111,6 +111,14 @@ export default {
                 tabs: true,
                 vPre: true,
                 vuePlayground: true,
+                // 文件导入
+                include: true,
+                // 容器
+                container: true,
+                // mermaid
+                mermaid: true,
+                // 自定义对齐
+                align: true,
             },
             copyCode: {
                 showInMobile: true