chore: remove commit history before open source

Author: shaunthegeek

.fnlint.json

@@ -0,0 +1,6 @@
+{
+  "basePath": ".",
+  "files": "source/**/*.md",
+  "format": "kebabcase",
+  "directories": true
+}

.git-pre-commit

@@ -0,0 +1,5 @@
+#!/bin/sh
+
+git diff --diff-filter=d --name-only HEAD | grep ".md$" | xargs npx remark -f
+git diff --diff-filter=d --name-only HEAD | grep ".md$" | xargs npx lint-md
+npx fnlint -c .fnlint.json

.gitignore

@@ -1,4 +1,7 @@
 node_modules
 .DS_Store
 db.json
-public
+public
+.idea
+*.log
+source/best-practices/overview.html

.lintmdrc

@@ -0,0 +1,9 @@
+{
+  "excludeFiles": [],
+  "rules": {
+    "no-long-code": [1, {
+      "length": 100,
+      "exclude": ["dot"]
+    }]
+  }
+}

CODEOWNERS

@@ -0,0 +1 @@
+source/* [email protected]

Jenkinsfile

@@ -0,0 +1,75 @@
+pipeline {
+  agent {
+    docker {
+      reuseNode 'true'
+      registryUrl 'https://coding-public-docker.pkg.coding.net'
+      image 'public/docker/nodejs:12'
+    }
+
+  }
+  stages {
+    stage('检出') {
+      steps {
+        checkout([
+          $class: 'GitSCM',
+          branches: [[name: '*']],
+          userRemoteConfigs: [[url: env.GIT_REPO_URL, credentialsId: env.CREDENTIALS_ID]]
+        ])
+        script {
+          if ( env.MR_SOURCE_BRANCH ==~ /.*/ ) {
+            sh "git checkout ${env.MR_TARGET_BRANCH}"
+            sh "git checkout ${env.MR_SOURCE_BRANCH}"
+          } else {
+            sh "git checkout ${env.GIT_COMMIT}"
+          }
+        }
+      }
+    }
+    stage('安装依赖') {
+      steps {
+        sh 'npm install'
+      }
+    }
+    stage('检查代码规范') {
+      when {
+        changeRequest()
+      }
+      steps {
+        sh "git diff --diff-filter=d --name-only ${env.MR_TARGET_BRANCH}... | grep '.md\$' | xargs npx remark -f"
+        sh "git diff --diff-filter=d --name-only ${env.MR_TARGET_BRANCH}... | grep '.md\$' | xargs npx lint-md"
+        sh "npx fnlint -c .fnlint.json"
+      }
+    }
+    stage('增量检查 git commit') {
+      when {
+        changeRequest()
+      }
+      steps {
+        script {
+          sh 'npm install'
+          sh """logs=`git log --pretty=format:'%s' ${env.MR_TARGET_BRANCH}... --no-merges`;
+          echo "\$logs" | while read i; do echo \$i | npx commitlint; done
+          """
+        }
+      }
+    }    
+    stage('构建') {
+      steps {
+        sh 'npx hexo generate'
+        sh 'node generate-overview.js prod'
+      }
+    }
+    stage('部署') {
+      when {
+        anyOf {
+          branch 'master'
+          tag '*'
+        }
+      }
+      steps {
+        sh 'mv public docs && mkdir public && mv docs public'
+        sh 'npx hexo deploy'
+      }
+    }
+  }
+}

README.md

@@ -0,0 +1,87 @@
+# CODING 帮助中心
+
+[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)
+
+本仓库是 CODING 帮助中心的文档，采用 Hexo 框架，Markdown 格式，通过持续集成强制检查下列规范：
+
+-   Git commit：[commitlint](https://juejin.im/post/6844903710112350221) 
+-   Markdown 英文：[remark](https://www.npmjs.com/package/remark-cli)
+-   Markdown 中文：[lint-md](https://github.com/lint-md/lint-md)
+
+参与本项目之前，建议先学习视频课程：[DevOps 代码质量实战：代码规范与 Git Flow](https://cloud.tencent.com/edu/learning/live-2837)
+
+## 目录结构
+
+```text
+├── Jenkinsfile
+├── _config.yml # Hexo 配置
+├── generate-overview.js
+├── patches
+│   └── hexo-renderer-marked.patch # 中文锚点补丁
+├── source # 所有文档
+│   ├── _data
+│   │   └── navigation.yml # 导航配置
+│   ├── foo
+│   └── bar
+└── themes
+    └── coding-help
+```
+
+## 本地构建
+
+```bash
+npm install
+
+# 本地预览
+hexo serve
+open http://127.0.0.1:4000/docs/start/new.html
+最佳实践：http://localhost:4000/docs/best-practices/overview.html
+
+# 生成 HTML
+hexo generate
+
+# 最佳实践的概览页
+# 注意 json 文件的 image 字段和 link 字段的格式，image 字段只需写图片名字，图片放在 themes/coding-help/source/images/best-practices
+
+vi source/_data/best-practices.json
+npm run best
+npm run dev
+open http://localhost:4000/docs/best-practices/overview.html
+```
+
+## 本地开发
+
+```shell
+git checkout master
+git pull
+git checkout -b issue-123
+vi xxx.md
+git add xxx.md
+
+# 运行标准化提交插件，按照提示输入信息
+npm install -g commitizen cz-conventional-changelog
+echo '{ "path": "cz-conventional-changelog" }' > ~/.czrc
+git cz
+
+git push origin issue-123
+
+# 网页创建合并请求
+```
+
+### 持续集成
+
+合并请求会触发持续集成，强制检查规范，如果失败，修改后重新提交。
+
+如果持续集成报错：git commit 不规范，参考文章进行修改：[修改 git 历史提交 commit 信息（重写历史）](https://help.coding.net/docs/ci/practice/lint/git-commit.html#modify)。
+
+commit 修改难度较高，也可回到 master，重新创建分支（注意不要重名），复制文件，重新提交。
+
+### Code Review
+
+持续集成通过后，由同事进行 code review，如果有问题，修改后重新提交。
+
+code review 原则：
+
+-   每次合并请求都必须经过 review；
+-   及时进行：不要跨天；
+-   必须通读，大部分时候都会发现问题；如果从来发现不了问题，随意批准，将被吊销 review 资格。

_config.yml

@@ -13,8 +13,8 @@ timezone:
 
 # URL
 ## If your site is put in a subdirectory, set url as 'http://yoursite.com/child' and root as '/child/'
-url: https://help.coding.net/
-root: /
+url: https://help.coding.net/docs/
+root: /docs/
 permalink: :year/:month/:day/:title/
 permalink_defaults:
 
@@ -27,20 +27,21 @@ category_dir: categories
 code_dir: downloads/code
 i18n_dir: :lang
 skip_render:
+  - "best-practices/overview.html"
 
 # Writing
 new_post_name: :title.md # File name of new posts
 default_layout: page
 titlecase: false # Transform title into titlecase
-external_link: true # Open external links in new tab
+external_link.enable: true # Open external links in new tab
 filename_case: 0
 render_drafts: false
 post_asset_folder: false
 relative_link: false
 future: true
 highlight:
-  enable: true
-  line_number: true
+  enable: false
+  line_number: false
   auto_detect: false
   tab_replace:
 
@@ -72,6 +73,7 @@ pagination_dir: page
 
 # Extensions
 ## Plugins: https://hexo.io/plugins/
+  
 ## Themes: https://hexo.io/themes/
 theme: coding-help
 
@@ -81,7 +83,30 @@ autoprefixer:
   overrideBrowserslist:
     - 'last 2 versions'
 
-# Deployment
+algolia:
+  applicationID: '9488ENB81Z'
+  apiKey: '8cd7d4251ad9bcd7d471b8b10e5e9d88'
+  indexName: 'coding-help-master'
+  
+
+# Deployment To COS
 ## Docs: https://hexo.io/docs/deployment.html
 deploy:
-  type:
+  type: cos
+  secretId:
+  secretKey:
+  bucket:
+  region:
+
+# hexo-renderer-marked
+## Docs: https://github.com/hexojs/hexo-renderer-marked
+marked:
+  anchorAlias: true
+
+# page-breadcrumb
+breadcrumb:
+  display: true
+
+# sitemap
+sitemap:
+  path: sitemap.xml

generate-overview.js

@@ -0,0 +1,86 @@
+/**
+ * 用于生成最佳实践页面的概览页
+ */
+var fs = require('fs');
+var path = require('path');
+var minify = require('html-minifier').minify;
+var BEST_PRACTICES_DATA = require('./source/_data/best-practices.json');
+
+var args = process.argv.slice(2)
+var isProd = args.length > 0 && args[0] === 'prod';
+
+var DATA = BEST_PRACTICES_DATA;
+var fileReadPath = path.resolve('source/_data/overview.html');
+var fileWritePath = path.resolve(`${isProd ? 'public' : 'source'}/best-practices/overview.html`);
+
+var html = fs.readFileSync(fileReadPath, { encoding: 'utf8' });
+
+var tabStr = '<div class="tab-wrapper"><div class="tab-inner">';
+
+var tabContentStr = '<div class="tab-content-outter"><div class="tab-content-wrapper">';
+
+for (var i = 0; i < DATA.length; i++) {
+    var tab = DATA[i];
+    var isIndex0 = i === 0;
+    // 拼接 tab 字符串
+    tabStr += `
+            <div class="tab-item ${isIndex0 ? 'show' : ''}" data-index="${i}">
+                ${tab.sort}
+                <span class="tab-indicator"></span>
+            </div>
+        `;
+    // 拼接 tabContent 字符串
+    tabContentStr += `<div class="tab-content ${isIndex0 ? 'show' : ''}">`;
+    // list的长度大于6，添加 查看更多
+    var list = tab.list;
+    var len = list.length;
+    var isOverSix = len > 6;
+    if (isOverSix) {
+        tabContentStr += `<div class="more-btn" data-index="${i}">查看更多</div>`;
+    }
+    // 遍历list         
+    for (var j = 0; j < len; j++) {
+        var item = list[j];
+        tabContentStr += `
+                <a href="${item.link}">
+                    <div class="tab-content-item ${j >= 6 ? 'hide' : ''}">
+                        <img src="../images/best-practice/${item.image}" alt="">
+                        <div class="tab-content-inner">
+                            <div class="up">
+                                <span>${item.image_title}</span>
+                            </div>
+                            <div class="down">
+                                <div class="down-up">
+                                    <h4>${item.title}</h4>
+                                    <p>${item.introduction}</p>
+                                </div>
+                                <div class="down-down">
+                                    <span>${item.author}</span>
+                                    <span>${item.date}</span>
+                                </div>
+                            </div>
+                        </div>
+                    </div>
+                </a>
+            `;
+    }
+    var padNum = len % 3;
+    padNum = padNum === 1 ? 2 : 1;
+    for (var k = 0; k < padNum; k++) {
+        tabContentStr += `<div class="tab-content-item none ${isOverSix ? 'hide' : ''}"></div>`;
+    }
+    tabContentStr += '</div>';
+}
+
+tabStr += '</div></div>';
+tabContentStr += '</div></div>';
+
+html = html.replace('<!-- TAB -->', tabStr).replace('<!-- TABCONTENT -->', tabContentStr);
+
+fs.writeFileSync(fileWritePath, minify(html, {
+    removeComments: true,
+    collapseWhitespace: true,
+    minifyJS: true,
+}));
+
+console.log('success');