docs: improve readme guideline

Author: yanglbme

.github/workflows/branch-merge.yml

@@ -2,7 +2,7 @@ name: Merge Branch
 
 on:
   push:
-    branches: [ imgbot ]
+    branches: [imgbot]
 
 jobs:
   merge-branch:
@@ -14,4 +14,4 @@ jobs:
           github_token: ${{ github.token }}
           source_ref: ${{ github.ref }}
           target_branch: main
-          commit_message_template: '[Automated] Merged {source_ref} into {target_branch}'
+          commit_message_template: "[Automated] Merged {source_ref} into {target_branch}"

.github/workflows/sync.yml

@@ -2,24 +2,24 @@ name: Sync
 
 on:
   push:
-    branches: [ main ]
+    branches: [main]
 
 jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-    - name: Sync to Gitee
-      uses: wearerequired/git-mirror-action@master
-      env:
+      - name: Sync to Gitee
+        uses: wearerequired/git-mirror-action@master
+        env:
           SSH_PRIVATE_KEY: ${{ secrets.GITEE_RSA_PRIVATE_KEY }}
-      with:
+        with:
           source-repo: [email protected]:doocs/doocs.github.io.git
           destination-repo: [email protected]:Doocs/doocs.git
 
-    - name: Build Gitee Pages
-      uses: yanglbme/gitee-pages-action@master
-      with:
+      - name: Build Gitee Pages
+        uses: yanglbme/gitee-pages-action@master
+        with:
           gitee-username: yanglbme
           gitee-password: ${{ secrets.GITEE_PASSWORD }}
           gitee-repo: doocs/doocs
-          branch: main
+          branch: main

README.md

@@ -1,9 +1,10 @@
 # Introduction
 
-[![GitHub](https://badgen.net/badge/icon/doocs?icon=github&label&color=green)](https://github.com/doocs)
-[![license](https://badgen.net/github/license/doocs/doocs.github.io?color=green)](https://github.com/doocs/doocs.github.io/blob/main/LICENSE)
+[![github](https://badgen.net/badge/>>/GitHub/cyan)](https://github.com/doocs/doocs.github.io)
+[![gitee](https://badgen.net/badge/>>/Gitee/cyan)](https://gitee.com/doocs/doocs)
 [![doocs-open-source-organization](https://badgen.net/badge/organization/join%20us/cyan)](#how-to-join)
 [![gitter](https://badgen.net/badge/gitter/chat/cyan)](https://gitter.im/doocs)
+[![license](https://badgen.net/github/license/doocs/doocs.github.io?color=green)](https://github.com/doocs/doocs.github.io/blob/main/LICENSE)
 
 Hello, everyone! Welcome to the [Doocs](https://github.com/doocs) Open Source organization. The name is originated from ‘Docs’, which mainly shares various development-related knowledge in the form of documents.
 
@@ -17,10 +18,11 @@ See the [中文文档](README_CN.md) for Chinese README.
 
 ## Owner
 
-[Yang Libin](https://github.com/yanglbme), a backend developer.
+[Yang Libin](https://github.com/yanglbme), focus on the inner workings of web applications to build out the "server-side" of web applications.
 
 - Wechat: YLB0109
 - Email: [[email protected]](mailto:[email protected])
+- Gitee: https://gitee.com/yanglbme
 - GitHub: https://github.com/yanglbme
 
 ## Projects
@@ -30,7 +32,7 @@ Doocs now has the following hot projects:
 
 | # | Project | Description | Popularity |
 | --- | --- | --- | --- |
-| 1   | [advanced-java](https://github.com/doocs/advanced-java)           | The advanced knowledge of Java developer, covering high concurrency, distributed systems, high availability, microservice, massive data processing, etc.             | ![](https://badgen.net/github/stars/doocs/advanced-java) <br>![](https://badgen.net/github/forks/doocs/advanced-java)           |
+| 1   | [advanced-java](https://github.com/doocs/advanced-java)           |  Core interview questions & answers for experienced Java(Backend) evelopers.             | ![](https://badgen.net/github/stars/doocs/advanced-java) <br>![](https://badgen.net/github/forks/doocs/advanced-java)           |
 | 2   | [leetcode](https://github.com/doocs/leetcode)                     | LeetCode solutions in any programming language.                                                                                                                      | ![](https://badgen.net/github/stars/doocs/leetcode) <br>![](https://badgen.net/github/forks/doocs/leetcode)                     |
 | 3   | [source-code-hunter](https://github.com/doocs/source-code-hunter) | Source code analysis of frameworks and components.                                                                                                                   | ![](https://badgen.net/github/stars/doocs/source-code-hunter) <br>![](https://badgen.net/github/forks/doocs/source-code-hunter) | ![](https://badgen.net/github/stars/doocs/coding-interview) <br>![](https://badgen.net/github/forks/doocs/source-code-hunter) |
 | 4   | [jvm](https://github.com/doocs/jvm)                               | A summary of the underlying principles of Java Virtual Machine.                                                                                                      | ![](https://badgen.net/github/stars/doocs/jvm) <br>![](https://badgen.net/github/forks/doocs/jvm)                               |
@@ -44,7 +46,7 @@ Doocs now has the following hot projects:
 
 I believe many of you have a deep understanding that participating in open source projects is very helpful for personal growth. If you love open source or you are curious about it, join Doocs, work with us, maintain our projects and grow together. You can join us in the following two ways:
 
-- Communicate directly on the [issues](https://github.com/doocs/doocs.github.io/issues/1) of this project.
+- Comment on [#1](https://github.com/doocs/doocs.github.io/issues/1) and tell us you want to join.
 - Send an email to [[email protected]](mailto:[email protected]?Subject=Join%20the%20Doocs%20Open%20Source%20organization) and attach your GitHub ID, such as [yanglbme](https://github.com/yanglbme).
 
 By default, your Doocs membership will be hidden from view aftering joining us. If you'd like to display the organization icon in your profile, you can switch from "Private" to "Public" here: https://github.com/orgs/doocs/people. We also recommend setting it to Public.

README_CN.md

@@ -1,9 +1,10 @@
 # 介绍
 
-[![GitHub](https://badgen.net/badge/icon/doocs?icon=github&label&color=green)](https://github.com/doocs)
-[![license](https://badgen.net/github/license/doocs/doocs.github.io?color=green)](https://github.com/doocs/doocs.github.io/blob/main/LICENSE)
+[![github](https://badgen.net/badge/>>/GitHub/cyan)](https://github.com/doocs/doocs.github.io)
+[![gitee](https://badgen.net/badge/>>/Gitee/cyan)](https://gitee.com/doocs/doocs)
 [![doocs-open-source-organization](https://badgen.net/badge/organization/join%20us/cyan)](#如何加入)
 [![gitter](https://badgen.net/badge/gitter/chat/cyan)](https://gitter.im/doocs)
+[![license](https://badgen.net/github/license/doocs/doocs.github.io?color=green)](https://github.com/doocs/doocs.github.io/blob/main/LICENSE)
 
 你好，欢迎来到 [Doocs](https://github.com/doocs) 开源组织。Doocs 名字取自 Docs，主要是以文档的形式分享各种开发相关知识。
 
@@ -17,11 +18,12 @@
 
 ## 发起人
 
-[杨立滨](https://github.com/yanglbme)，专注于互联网后端开发。
+[杨立滨](https://github.com/yanglbme)，专注于互联网后端领域。
 
 - 微信： YLB0109
 - 邮箱：[[email protected]](mailto:[email protected])
-- 同性交友账号: https://github.com/yanglbme
+- Gitee：https://gitee.com/yanglbme
+- GitHub: https://github.com/yanglbme
 
 ## 项目
 
@@ -45,7 +47,7 @@
 
 如果你热爱开源，或者抱着一颗好奇的心，不妨加入 [Doocs](https://github.com/doocs) 组织，和我们一起维护项目，共同成长。可以通过以下两种方式加入：
 
-- 直接在[此项目](https://github.com/doocs/doocs.github.io)的 [issue](https://github.com/doocs/doocs.github.io/issues/1) 上交流。
+- 直接在[此项目](https://github.com/doocs/doocs.github.io)的 [issue](https://github.com/doocs/doocs.github.io/issues/1) 上评论，告知我们你想加入 Doocs。
 - 发送邮件到 [[email protected]](mailto:[email protected]?Subject=加入Doocs开源组织)，写明你的 GitHub ID，如 [yanglbme](https://github.com/yanglbme)。
 
 默认情况下，在你加入我们之后，你作为 GitHub Doocs 组织成员的信息是处于隐藏状态的。如果你希望在你的个人 GitHub 资料页上展示 Doocs 组织，你可以在此链接 https://github.com/orgs/doocs/people 处将你的信息从 `private` “**私有**”改为 `public` “**公开**”。当然，我们推荐设置为**公开**。

index.html

@@ -1,102 +1,83 @@
 <!DOCTYPE html>
 <html lang="en">
-  <head>
-    <meta charset="UTF-8" />
-    <title>Welcome to join the Doocs Open Source organization</title>
-    <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
-    <meta name="description" content="Doocs's Home" />
-    <meta
-      name="viewport"
-      content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0"
-    />
-    <link
-      rel="stylesheet"
-      href="//cdn.jsdelivr.net/npm/docsify/lib/themes/vue.css"
-    />
-    <link
-      rel="stylesheet"
-      href="//cdn.jsdelivr.net/npm/[email protected]/dist/style.css"
-    />
-    <link
-      rel="stylesheet"
-      href="//cdn.jsdelivr.net/npm/gitalk/dist/gitalk.css"
-    />
-    <link
-      rel="icon"
-      type="image/png"
-      sizes="32x32"
-      href="images/favicon-32x32.png"
-    />
-    <link
-      rel="icon"
-      type="image/png"
-      sizes="16x16"
-      href="images/favicon-16x16.png"
-    />
-  </head>
-  <body>
-    <nav>
-      <ul>
-        <li><a href="#README_CN">中文</a></li>
-        <li><a href="#">En</a></li>
-      </ul>
-    </nav>
-    <div id="app">欢迎来到 Doocs 开源社区</div>
-    <script>
-      window.$docsify = {
-        name: "Doocs",
-        // repo: 'doocs/doocs.github.io',
-        logo: "/images/favicon-32x32.png",
-        auto2top: true,
-        search: ["/"],
-        darkMode: {
-          light: {
-            toggleBtnBg: "#42b983",
-          },
+
+<head>
+  <meta charset="UTF-8" />
+  <title>Welcome to join the Doocs Open Source organization</title>
+  <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
+  <meta name="description" content="Doocs's Home" />
+  <meta name="viewport"
+    content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0" />
+  <link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify/lib/themes/vue.css" />
+  <link rel="stylesheet" href="//cdn.jsdelivr.net/npm/[email protected]/dist/style.css" />
+  <link rel="stylesheet" href="//cdn.jsdelivr.net/npm/gitalk/dist/gitalk.css" />
+  <link rel="icon" type="image/png" sizes="32x32" href="images/favicon-32x32.png" />
+  <link rel="icon" type="image/png" sizes="16x16" href="images/favicon-16x16.png" />
+</head>
+
+<body>
+  <nav>
+    <ul>
+      <li><a href="#README_CN">中文</a></li>
+      <li><a href="#">En</a></li>
+    </ul>
+  </nav>
+  <div id="app">欢迎来到 Doocs 开源社区</div>
+  <script>
+    window.$docsify = {
+      name: "Doocs",
+      logo: "/images/favicon-32x32.png",
+      auto2top: true,
+      search: ["/"],
+      darkMode: {
+        light: {
+          toggleBtnBg: "#42b983",
+        },
+      },
+      plugins: [
+        function (hook) {
+          var footer = [
+            "<hr/>",
+            "<footer>",
+            '<span>Copyright © 2018-2021 <a href="https://github.com/doocs" target="_blank">Doocs</a>. All rights reserved.',
+            "</footer>",
+          ].join("");
+
+          hook.afterEach(function (html) {
+            return html + footer;
+          });
         },
-        plugins: [
-          function (hook) {
-            var footer = [
-              "<hr/>",
-              "<footer>",
-              '<span>Copyright © 2018-2020 <a href="https://github.com/doocs" target="_blank">Doocs</a>. All rights reserved.',
-              "</footer>",
-            ].join("");
+      ],
+    };
+  </script>
+  <script src="//cdn.jsdelivr.net/npm/docsify/lib/docsify.min.js"></script>
+  <script src="//cdn.jsdelivr.net/npm/prismjs/components/prism-c.min.js"></script>
+  <script src="//cdn.jsdelivr.net/npm/prismjs/components/prism-bash.min.js"></script>
+  <script src="//cdn.jsdelivr.net/npm/prismjs/components/prism-cpp.min.js"></script>
+  <script src="//cdn.jsdelivr.net/npm/prismjs/components/prism-json.min.js"></script>
+  <script src="//cdn.jsdelivr.net/npm/prismjs/components/prism-java.min.js"></script>
+  <script src="//cdn.jsdelivr.net/npm/prismjs/components/prism-python.min.js"></script>
+  <script src="//cdn.jsdelivr.net/npm/docsify-copy-code"></script>
+  <script src="//cdn.jsdelivr.net/npm/docsify/lib/plugins/search.js"></script>
+  <script src="//cdn.jsdelivr.net/npm/docsify/lib/plugins/emoji.js"></script>
+  <script src="//cdn.jsdelivr.net/npm/docsify/lib/plugins/zoom-image.js"></script>
+  <script src="//cdn.jsdelivr.net/npm/docsify/lib/plugins/gitalk.min.js"></script>
+  <script src="//cdn.jsdelivr.net/npm/gitalk/dist/gitalk.min.js"></script>
+  <script src="//cdn.jsdelivr.net/npm/[email protected]/dist/index.js"></script>
+  <script>
+    const gitalk = new Gitalk({
+      clientID: "88a228f7139b31216822",
+      clientSecret: "d2c7e7c11b91d2e0f3d7ed3ed1ab1b2c08ad5591",
+      repo: "doocs.github.io",
+      owner: "doocs",
+      admin: ["yanglbme"],
+      number: 1,
+      distractionFreeMode: true,
+      labels: ["talk"],
+      title: "Welcome to join the Doocs Open Source organization",
+      perPage: 15,
+    });
+  </script>
+</body>
 
-            hook.afterEach(function (html) {
-              return html + footer;
-            });
-          },
-        ],
-      };
-    </script>
-    <script src="//cdn.jsdelivr.net/npm/docsify/lib/docsify.min.js"></script>
-    <script src="//cdn.jsdelivr.net/npm/prismjs/components/prism-c.min.js"></script>
-    <script src="//cdn.jsdelivr.net/npm/prismjs/components/prism-bash.min.js"></script>
-    <script src="//cdn.jsdelivr.net/npm/prismjs/components/prism-cpp.min.js"></script>
-    <script src="//cdn.jsdelivr.net/npm/prismjs/components/prism-json.min.js"></script>
-    <script src="//cdn.jsdelivr.net/npm/prismjs/components/prism-java.min.js"></script>
-    <script src="//cdn.jsdelivr.net/npm/prismjs/components/prism-python.min.js"></script>
-    <script src="//cdn.jsdelivr.net/npm/docsify-copy-code"></script>
-    <script src="//cdn.jsdelivr.net/npm/docsify/lib/plugins/search.js"></script>
-    <script src="//cdn.jsdelivr.net/npm/docsify/lib/plugins/emoji.js"></script>
-    <script src="//cdn.jsdelivr.net/npm/docsify/lib/plugins/zoom-image.js"></script>
-    <script src="//cdn.jsdelivr.net/npm/docsify/lib/plugins/gitalk.min.js"></script>
-    <script src="//cdn.jsdelivr.net/npm/gitalk/dist/gitalk.min.js"></script>
-    <script src="//cdn.jsdelivr.net/npm/[email protected]/dist/index.js"></script>
-    <script>
-      const gitalk = new Gitalk({
-        clientID: "88a228f7139b31216822",
-        clientSecret: "d2c7e7c11b91d2e0f3d7ed3ed1ab1b2c08ad5591",
-        repo: "doocs.github.io",
-        owner: "doocs",
-        admin: ["yanglbme"],
-        number: 1,
-        distractionFreeMode: true,
-        labels: ["talk"],
-        title: "Welcome to join the Doocs Open Source organization",
-        perPage: 15,
-      });
-    </script>
-  </body>
-</html>
+</html>