introduction (#54)

HZFE · Sep 11, 2021 · 08565ec · 08565ec
1 parent 4e89542
commit 08565ec
Show file tree

Hide file tree

Showing 47 changed files with 427 additions and 156 deletions.
diff --git a/README.md b/README.md
@@ -1,12 +1,7 @@
 # 小册开发必看
 
-<!--
-已知掘金小册的编辑器使用标准 markdown 语法。所以等我们在 GitHub 上迭代完小册第一版内容后，再统一搬运去掘金。以下截图是掘金小册的编辑器：
-
-![image](https://user-images.githubusercontent.com/17002181/124560094-04e84880-de6f-11eb-90cb-564076152927.png) -->
-
 1. 为了方便多人协作编写小册内容，所以使用 Git 仓库来进行管理。
-2. 为了方便本地环境预览小册的 markdown 内容，所以使用 gitbook 工具进行文件结构管理。
+2. 为了方便本地环境预览小册的 markdown 内容，所以使用 docusaurus 工具进行文件结构管理。
 
 ## 内容选题
 
@@ -28,3 +23,14 @@ npm start
 共 5 套模拟题，每套 12 题。按**题**开分支，需要提交 PR，review 通过后 merge 进 main 分支。
 
 请基于 `.template` 中的内容模板进行写作。不硬性规定格式必须完全一致，但请在参考和贴近模板的前提下进行拓展。
+
+## 部署流程
+
+目前的方法是手动执行以下命令，触发部署流程。部署前请在群里先同步，也确保你的开发环境中没有其他未 push/Verified 的内容。
+
+```bash
+# Akiq2016 换成你的 GitHub 名称
+# 执行以下这条命令后，会将构建出的build目录下的内容，强推到开源库（https://github.com/HZFE/awesome-interview）
+# 对应的静态页面（https://hzfe.github.io/awesome-interview）也会更新
+export GIT_USER=Akiq2016 && npm run deploy
+```
diff --git a/SUMMARY.md b/SUMMARY.md
diff --git a/static/pic.sketch → backlog/pic.sketch b/static/pic.sketch → backlog/pic.sketch
diff --git a/docs/book1/algorithm-balanced-binary-trees.md b/docs/book1/algorithm-balanced-binary-trees.md
@@ -1,5 +1,5 @@
 ---
-sidebar_label: 【算法】平衡二叉树
+sidebar_label: 算法：平衡二叉树
 sidebar_position: 11
 ---
 

diff --git a/docs/book1/browser-cross-origin.md b/docs/book1/browser-cross-origin.md
@@ -1,5 +1,5 @@
 ---
-sidebar_label: 【浏览器】浏览器跨域
+sidebar_label: 浏览器：浏览器跨域
 sidebar_position: 1
 ---
 

diff --git a/docs/book1/browser-repain-reflow.md b/docs/book1/browser-repain-reflow.md
@@ -1,5 +1,5 @@
 ---
-sidebar_label: 【浏览器】浏览器的重排重绘
+sidebar_label: 浏览器：浏览器的重排重绘
 sidebar_position: 2
 ---
 

diff --git a/docs/book1/coding-promise.md b/docs/book1/coding-promise.md
@@ -1,5 +1,5 @@
 ---
-sidebar_label: 【编码】实现一个 Promises/A+
+sidebar_label: 编码：实现一个 Promises/A+
 sidebar_position: 10
 ---
 

diff --git a/docs/book1/css-bfc.md b/docs/book1/css-bfc.md
@@ -1,5 +1,5 @@
 ---
-sidebar_label: 【样式】BFC 的形成和作用
+sidebar_label: 样式：BFC 的形成和作用
 sidebar_position: 8
 ---
 

diff --git a/docs/book1/engineer-webpack-workflow.md b/docs/book1/engineer-webpack-workflow.md
@@ -1,4 +1,4 @@
 ---
-sidebar_label: 【工程化】Webpack 工作流程
+sidebar_label: 工程化：Webpack 工作流程
 sidebar_position: 3
 ---
diff --git a/docs/book1/frame-vue-computed-watch.md b/docs/book1/frame-vue-computed-watch.md
@@ -1,5 +1,5 @@
 ---
-sidebar_label: 【框架】Vue 的 computed 和 watch 的区别
+sidebar_label: 框架：Vue 的 computed 和 watch 的区别
 sidebar_position: 5
 ---
 

diff --git a/docs/book1/frame-vue-data-binding.md b/docs/book1/frame-vue-data-binding.md
@@ -1,5 +1,5 @@
 ---
-sidebar_label: 【框架】Vue 的数据绑定机制
+sidebar_label: 框架：Vue 的数据绑定机制
 sidebar_position: 4
 ---
 

diff --git a/docs/book1/js-closures.md b/docs/book1/js-closures.md
@@ -1,5 +1,5 @@
 ---
-sidebar_label: 【基础】闭包的作用和原理
+sidebar_label: 基础：闭包的作用和原理
 sidebar_position: 6
 ---
 

diff --git a/docs/book1/js-module-specs.md b/docs/book1/js-module-specs.md
@@ -1,5 +1,5 @@
 ---
-sidebar_label: 【基础】前端模块化规范
+sidebar_label: 基础：前端模块化规范
 sidebar_position: 7
 ---
 
@@ -115,7 +115,8 @@ define("hzfe", [], function () {
 });
 
 // index.js
-require(["hzfe"], function (hzfe) { // 依赖前置
+require(["hzfe"], function (hzfe) {
+  // 依赖前置
   console.log(hzfe.getHZFEMember()); // HZFE Member: 17
 });
 ```

diff --git a/docs/book1/network-security.md b/docs/book1/network-security.md
@@ -1,5 +1,5 @@
 ---
-sidebar_label: 【网络】前端安全
+sidebar_label: 网络：前端安全
 sidebar_position: 9
 ---
 

diff --git a/docs/book1/topic-enter-url-display-xx.md b/docs/book1/topic-enter-url-display-xx.md
@@ -1,5 +1,5 @@
 ---
-sidebar_label: 【综合】浏览器从输入网址到页面展现的过程
+sidebar_label: 综合：浏览器从输入网址到页面展现的过程
 sidebar_position: 12
 ---
 

diff --git a/docs/book2/algorithm-reverse-linked-list.md b/docs/book2/algorithm-reverse-linked-list.md
@@ -1,5 +1,5 @@
 ---
-sidebar_label: 【算法】反转链表
+sidebar_label: 算法：反转链表
 sidebar_position: 11
 ---
 

diff --git a/docs/book2/browser-garbage.md b/docs/book2/browser-garbage.md
@@ -1,5 +1,5 @@
 ---
-sidebar_label: 【浏览器】垃圾回收机制
+sidebar_label: 浏览器：垃圾回收机制
 sidebar_position: 2
 ---
 

diff --git a/docs/book2/browser-render-mechanism.md b/docs/book2/browser-render-mechanism.md
@@ -1,5 +1,5 @@
 ---
-sidebar_label: 【浏览器】浏览器渲染机制
+sidebar_label: 浏览器：浏览器渲染机制
 sidebar_position: 1
 ---
 

diff --git a/docs/book2/coding-throttle-debounce.md b/docs/book2/coding-throttle-debounce.md
@@ -1,5 +1,5 @@
 ---
-sidebar_label: 【编码】实现节流去抖函数
+sidebar_label: 编码：实现节流去抖函数
 sidebar_position: 10
 ---
 

diff --git a/docs/book2/css-preprocessor.md b/docs/book2/css-preprocessor.md
@@ -1,5 +1,5 @@
 ---
-sidebar_label: 【样式】谈谈 CSS 预处理器
+sidebar_label: 样式：谈谈 CSS 预处理器
 sidebar_position: 8
 ---
 

diff --git a/docs/book2/engineer-babel.md b/docs/book2/engineer-babel.md
@@ -1,5 +1,5 @@
 ---
-sidebar_label: 【工程化】Babel 的原理
+sidebar_label: 工程化：Babel 的原理
 sidebar_position: 3
 ---
 

diff --git a/docs/book2/frame-react-fiber.md b/docs/book2/frame-react-fiber.md
@@ -1,5 +1,5 @@
 ---
-sidebar_label: 【框架】React Fiber 的作用和原理
+sidebar_label: 框架：React Fiber 的作用和原理
 sidebar_position: 4
 ---
 

diff --git a/docs/book2/frame-react-hoc-hooks.md b/docs/book2/frame-react-hoc-hooks.md
@@ -1,5 +1,5 @@
 ---
-sidebar_label: 【框架】HOC vs Render Props vs Hooks
+sidebar_label: 框架：HOC vs Render Props vs Hooks
 sidebar_position: 5
 ---
 

diff --git a/docs/book2/js-inherite.md b/docs/book2/js-inherite.md
@@ -1,5 +1,5 @@
 ---
-sidebar_label: 【基础】ES5、ES6 如何实现继承
+sidebar_label: 基础：ES5、ES6 如何实现继承
 sidebar_position: 6
 ---
 

diff --git a/docs/book2/js-new.md b/docs/book2/js-new.md
@@ -1,5 +1,5 @@
 ---
-sidebar_label: 【基础】New 操作符的原理
+sidebar_label: 基础：New 操作符的原理
 sidebar_position: 7
 ---
 

diff --git a/docs/book2/network-http-cache.md b/docs/book2/network-http-cache.md
@@ -1,5 +1,5 @@
 ---
-sidebar_label: 【网络】HTTP 缓存机制
+sidebar_label: 网络：HTTP 缓存机制
 sidebar_position: 9
 ---
 

diff --git a/docs/book2/topic-multi-pics-site-optimize.md b/docs/book2/topic-multi-pics-site-optimize.md
@@ -1,5 +1,5 @@
 ---
-sidebar_label: 【综合】多图站点性能优化
+sidebar_label: 综合：多图站点性能优化
 sidebar_position: 12
 ---
 

diff --git a/docs/book3/algorithm-binary-tree-k.md b/docs/book3/algorithm-binary-tree-k.md
@@ -1,5 +1,5 @@
 ---
-sidebar_label: 【算法】二叉搜索树的第 k 个结点
+sidebar_label: 算法：二叉搜索树的第 k 个结点
 sidebar_position: 11
 ---
 

diff --git a/docs/book3/browser-event-loop.md b/docs/book3/browser-event-loop.md
@@ -1,5 +1,5 @@
 ---
-sidebar_label: 【浏览器】浏览器事件循环
+sidebar_label: 浏览器：浏览器事件循环
 sidebar_position: 1
 ---
 

diff --git a/docs/book3/browser-memory-leaks.md b/docs/book3/browser-memory-leaks.md
@@ -1,5 +1,5 @@
 ---
-sidebar_label: 【浏览器】如何定位内存泄露
+sidebar_label: 浏览器：如何定位内存泄露
 sidebar_position: 2
 ---
 

diff --git a/docs/book3/coding-arr-to-tree.md b/docs/book3/coding-arr-to-tree.md
@@ -1,5 +1,5 @@
 ---
-sidebar_label: 【编码】将列表还原为树状结构
+sidebar_label: 编码：将列表还原为树状结构
 sidebar_position: 10
 ---
 

diff --git a/docs/book3/css-mobile-adaptive.md b/docs/book3/css-mobile-adaptive.md
@@ -1,5 +1,5 @@
 ---
-sidebar_label: 【样式】移动端自适应的常见手段
+sidebar_label: 样式：移动端自适应的常见手段
 sidebar_position: 8
 ---
 

diff --git a/docs/book3/engineer-webpack-loader.md b/docs/book3/engineer-webpack-loader.md
@@ -1,4 +1,4 @@
 ---
-sidebar_label: 【工程化】谈下 webpack loader 的机制
+sidebar_label: 工程化：谈下 webpack loader 的机制
 sidebar_position: 3
 ---
diff --git a/docs/book3/frame-diff.md b/docs/book3/frame-diff.md
@@ -1,5 +1,5 @@
 ---
-sidebar_label: 【框架】常见框架的 Diff 算法
+sidebar_label: 框架：常见框架的 Diff 算法
 sidebar_position: 5
 ---
 

diff --git a/docs/book3/frame-react-hooks.md b/docs/book3/frame-react-hooks.md
@@ -1,5 +1,5 @@
 ---
-sidebar_label: 【框架】React Hooks 实现原理
+sidebar_label: 框架：React Hooks 实现原理
 sidebar_position: 4
 ---
 

diff --git a/docs/book3/js-async.md b/docs/book3/js-async.md
@@ -1,5 +1,5 @@
 ---
-sidebar_label: 【基础】JavaScript 异步编程
+sidebar_label: 基础：JavaScript 异步编程
 sidebar_position: 6
 ---
 

diff --git a/docs/book3/js-ts-interface-type.md b/docs/book3/js-ts-interface-type.md
@@ -1,5 +1,5 @@
 ---
-sidebar_label: 【基础】TypeScript 中的 Interface 和 Type Alias
+sidebar_label: 基础：TypeScript 中的 Interface 和 Type Alias
 sidebar_position: 7
 ---
 

diff --git a/docs/book3/network-http-1-2.md b/docs/book3/network-http-1-2.md
@@ -1,5 +1,5 @@
 ---
-sidebar_label: 【网络】HTTP2 和 HTTP1.1 的对比
+sidebar_label: 网络：HTTP2 和 HTTP1.1 的对比
 sidebar_position: 9
 ---
 

diff --git a/docs/book3/topic-white-screen-optimization.md b/docs/book3/topic-white-screen-optimization.md
@@ -1,5 +1,5 @@
 ---
-sidebar_label: 【综合】如何减少白屏的时间
+sidebar_label: 综合：如何减少白屏的时间
 sidebar_position: 12
 ---