feat: use vuepress-theme-hope

.github/workflows/build.yml

@@ -0,0 +1,39 @@
+name: Deploy docs
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  deploy-gh-pages:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          submodules: true
+          fetch-depth: 0
+
+      - uses: actions/cache@v3
+        id: node-modules
+        with:
+          path: node_modules/
+          key: ${{ runner.os }}-node-modules-${{ hashFiles('yarn.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-node-modules-
+
+      - name: Install Deps
+        if: steps.node-modules.outputs.cache-hit != 'true'
+        run: yarn install --frozen-lockfile
+
+      - name: Build Docs
+        env:
+          NODE_OPTIONS: --max_old_space_size=4096
+        run: yarn run build:webpack
+
+      - name: Deploy
+        uses: JamesIves/github-pages-deploy-action@v4
+        with:
+          branch: gh-pages
+          folder: dist

.gitignore

@@ -1,2 +1,7 @@
-node_modules
+.vuepress/.cache/
+**/.vuepress/.cache/**
+**/.vuepress/.temp/**
+
+dist/**
+node_modules/**
 .DS_Store

README.md

@@ -1,44 +1,41 @@
 # IDEA 高效使用指南
 
-<div align="center">
-    <p>
-        <a href="https://www.yuque.com/docs/share/8a30ffb5-83f3-40f9-baf9-38de68b906dc">
-            <img src="https://img-blog.csdnimg.cn/48dccc72371e45e5b7e64663760e4d76.png?" style="margin: 0 auto; width: 850px;" />
-        </a>
-    </p>
-    <p>
-        <a href="https://github.com/CodingDocs/awesome-idea-tutorial">Github</a> |
-        <a href="https://gitee.com/SnailClimb/awesome-idea-tutorial">Gitee</a>
-    </p>  
-</div>
+<p align="center">
+  <a href="https://www.yuque.com/docs/share/8a30ffb5-83f3-40f9-baf9-38de68b906dc">
+    <img src="https://img-blog.csdnimg.cn/48dccc72371e45e5b7e64663760e4d76.png?" style="margin: 0 auto; width: 850px;" />
+  </a>
+</p>
+<p align="center">
+  <a href="https://github.com/CodingDocs/awesome-idea-tutorial">Github</a> |
+  <a href="https://gitee.com/SnailClimb/awesome-idea-tutorial">Gitee</a>
+</p>
 
 IntelliJ IDEA 使用指南 | 必备插件推荐 | 插件开发入门 | 重构小技巧 | 源码阅读技巧
 
 ## 小技巧
 
-- [IDEA 高效使用指南](./docs/idea-tips/idea-efficient-use-guide.md)
-- [IDEA 高效重构指南](./docs/idea-tips/idea-refractor-intro.md)
-- [IDEA 插件开发入门](./docs/idea-tips/idea-plug-in-development-intro.md)
-- [IDEA 源码阅读小技巧](./docs/idea-tips/idea-source-code-reading-skills.md)
+- [IDEA 高效使用指南](./docs/tips/efficient-use-guide.md)
+- [IDEA 高效重构指南](./docs/tips/refractor-intro.md)
+- [IDEA 插件开发入门](./docs/tips/plug-in-development-intro.md)
+- [IDEA 源码阅读小技巧](./docs/tips/source-code-reading-skills.md)
 
 ## 必备插件
 
-- [IDEA 快捷键相关插件](./docs/idea-plugins/shortcut-key.md)
-- [IDEA 优质主题推荐](./docs/idea-plugins/idea-themes.md)
-- [IDEA 代码优化插件推荐](./docs/idea-plugins/improve-code.md)
-- [IDEA 界面美化插件推荐](./docs/idea-plugins/interface-beautification.md)
-
-
-
-- [Camel Case：命名之间快速切换](./docs/idea-plugins/camel-case.md)
-- [CodeGlance：代码微型地图](./docs/idea-plugins/code-glance.md)
-- [Statistic：项目代码统计](./docs/idea-plugins/code-statistic.md)
-- [Git Commit Template：提交代码格式规范](./docs/idea-plugins/git-commit-template.md)
-- [GsonFormat：JSON 转对象](./docs/idea-plugins/gson-format.md)
-- [IDE Features Trainer：IDEA 交互式教程](./docs/idea-plugins/idea-features-trainer.md)
-- [jclasslib ：一款 IDEA 字节码查看神器](./docs/idea-plugins/jclasslib.md)
-- [Maven Helper：解决 Maven 依赖冲突问题](./docs/idea-plugins/maven-helper.md)
-- [RestfulToolkit：RESTful Web 服务辅助开发工具](./docs/idea-plugins/rest-devlop.md)
-- [Save Actions：优化文件保存](./docs/idea-plugins/save-actions.md)
-- [SequenceDiagram：一键可以生成时序图](./docs/idea-plugins/sequence-diagram.md)
-- [Translation：翻译](./docs/idea-plugins/translation.md)
+- [IDEA 快捷键相关插件](./docs/plugins/shortcut-key.md)
+- [IDEA 优质主题推荐](./docs/plugins/themes.md)
+- [IDEA 代码优化插件推荐](./docs/plugins/improve-code.md)
+- [IDEA 界面美化插件推荐](./docs/plugins/interface-beautification.md)
+
+- [Camel Case: 命名之间快速切换](./docs/plugins/camel-case/README.md)
+- [CodeGlance: 代码微型地图](./docs/plugins/code-glance/README.md)
+- [Statistic: 项目代码统计](./docs/plugins/code-statistic/README.md)
+- [Git Commit Template: 提交代码格式规范](./docs/plugins/git-commit-template/README.md)
+- [GsonFormat: JSON 转对象](./docs/plugins/gson-format/README.md)
+- [IDE Features Trainer: IDEA 交互式教程](./docs/plugins/idea-features-trainer/README.md)
+- [jclasslib: 一款 IDEA 字节码查看神器](./docs/plugins/jclasslib.md)
+- [Maven Helper: 解决 Maven 依赖冲突问题](./docs/plugins/maven-helper.md)
+- [RestfulToolkit: RESTful Web 服务辅助开发工具](./docs/plugins/rest/README.md)
+- [Save Actions: 优化文件保存](./docs/plugins/save-actions/README.md)
+- [SequenceDiagram: 一键可以生成时序图](./docs/plugins/sequence-diagram.md)
+- [Translation: 翻译](./docs/plugins/translation/README.md)
+- [其他](./docs/plugins/others.md)

docs/.vuepress/config.ts

@@ -0,0 +1,18 @@
+import { defineHopeConfig } from "vuepress-theme-hope";
+import themeConfig from "./themeConfig";
+
+export default defineHopeConfig({
+  base: "/awesome-idea/",
+
+  dest: "./dist",
+
+  title: "IDEA 高效使用指南",
+
+  locales: {
+    "/": {
+      lang: "zh-CN",
+    },
+  },
+
+  themeConfig,
+});

docs/.vuepress/navbar.ts

@@ -0,0 +1,3 @@
+import { defineNavbarConfig } from "vuepress-theme-hope";
+
+export default defineNavbarConfig(["/plugins/", "/tips/"]);

docs/.vuepress/sidebar.ts

@@ -0,0 +1,31 @@
+import { defineSidebarConfig } from "vuepress-theme-hope";
+
+export default defineSidebarConfig([
+  {
+    text: "技巧",
+    prefix: "tip/",
+    collapsable: false,
+    children: "structure",
+  },
+  {
+    text: "插件",
+    prefix: "plugins/",
+    children: [
+      "shortcut-key",
+      "themes",
+      "improve-code",
+      "interface-beautification",
+      "camel-case/",
+      "code-glance/",
+      "code-statistic/",
+      "git-commit-template/",
+      "gson-format/",
+      "jclasslib/",
+      "maven-helper",
+      "rest/",
+      "sequence-diagram/",
+      "translation/",
+      "others",
+    ],
+  },
+]);

docs/.vuepress/styles/index.scss

@@ -0,0 +1 @@
+@import "//at.alicdn.com/t/font_2410206_vuzkjonf4s9.css";

docs/.vuepress/themeConfig.ts

@@ -0,0 +1,54 @@
+import { defineThemeConfig } from "vuepress-theme-hope";
+import navbar from "./navbar";
+import sidebar from "./sidebar";
+
+export default defineThemeConfig({
+  title: "IDEA 高效使用指南",
+
+  author: "Guide",
+
+  logo: "/logo.svg",
+  hostname: "https://codingdocs.github.io",
+  repo: "CodingDocs/awesome-idea",
+  docsDir: "docs",
+  iconPrefix: "iconfont icon-",
+  pure: true,
+
+  navbar,
+  sidebar,
+
+  pageInfo: ["Author", "Category", "Tag", "Date", "Original", "Word"],
+
+  blog: {
+    intro: "https://javaguide.cn/about-the-author/",
+    sidebarDisplay: "mobile",
+    medias: {
+      Zhihu: "https://www.zhihu.com/people/javaguide",
+      Github: "https://github.com/Snailclimb",
+      Gitee: "https://gitee.com/SnailClimb",
+    },
+  },
+
+  footer:
+    '主题: <a href="https://vuepress-theme-hope.github.io/v2/">VuePress Theme Hope</a>',
+  displayFooter: true,
+
+  plugins: {
+    blog: {
+      autoExcerpt: true,
+    },
+    mdEnhance: {
+      gfm: true,
+    },
+    feed: {
+      json: true,
+    },
+    search: {
+      locales: {
+        "/": {
+          placeholder: "搜索",
+        },
+      },
+    },
+  },
+});

docs/README.md

@@ -0,0 +1,38 @@
+---
+home: true
+icon: home
+title: 主页
+heroText: IDEA 高效使用指南
+heroImage: /logo.svg
+tagline: IntelliJ IDEA 使用指南 | 必备插件推荐 | 插件开发入门 | 重构小技巧 | 源码阅读技巧
+---
+
+## 小技巧
+
+- [IDEA 高效使用指南](./tips/efficient-use-guide.md)
+- [IDEA 高效重构指南](./tips/refractor-intro.md)
+- [IDEA 插件开发入门](./tips/plug-in-development-intro.md)
+- [IDEA 源码阅读小技巧](./tips/source-code-reading-skills.md)
+
+## 必备插件
+
+- [IDEA 快捷键相关插件](./plugins/shortcut-key.md)
+- [IDEA 优质主题推荐](./plugins/themes.md)
+- [IDEA 代码优化插件推荐](./plugins/improve-code.md)
+- [IDEA 界面美化插件推荐](./plugins/interface-beautification.md)
+
+---
+
+- [Camel Case: 命名之间快速切换](./plugins/camel-case/README.md)
+- [CodeGlance: 代码微型地图](./plugins/code-glance/README.md)
+- [Statistic: 项目代码统计](./plugins/code-statistic/README.md)
+- [Git Commit Template: 提交代码格式规范](./plugins/git-commit-template/README.md)
+- [GsonFormat: JSON 转对象](./plugins/gson-format/README.md)
+- [IDE Features Trainer: IDEA 交互式教程](./plugins/idea-features-trainer/README.md)
+- [jclasslib: 一款 IDEA 字节码查看神器](./plugins/jclasslib/README.md)
+- [Maven Helper: 解决 Maven 依赖冲突问题](./plugins/maven-helper.md)
+- [RestfulToolkit: RESTful Web 服务辅助开发工具](./plugins/rest/README.md)
+- [Save Actions: 优化文件保存](./plugins/save-actions/README.md)
+- [SequenceDiagram: 一键可以生成时序图](./plugins/sequence-diagram.md)
+- [Translation: 翻译](./plugins/translation/README.md)
+- [其他](./plugins/others.md)