more standard doc format

stormckey · Nov 26, 2023 · 31d7d24 · 31d7d24
1 parent c4f32f9
commit 31d7d24
Show file tree

Hide file tree

Showing 50 changed files with 748 additions and 744 deletions.
diff --git a/docs/Blog/Cool/GPT_academic.md b/docs/Blog/Cool/GPT_academic.md
@@ -4,12 +4,12 @@ comments: true
 # Enable ChatGPT_academic
 
 !!! info "准备工作"
-    请在阅读此文前准备好ChatGPT的API Key和好用的代理。（前者主要是注册好账号就行，合理利用https://sms-activate.org/）
+    请在阅读此文前准备好 ChatGPT 的 API Key 和好用的代理。（前者主要是注册好账号就行，合理利用 https://sms-activate.org/）
 
-主要的流程就在项目的[:octicons-link-16:源地址](https://github.com/binary-husky/chatgpt_academic)讲的很详细了,照做即可。
+主要的流程就在项目的[:octicons-link-16:源地址](https://github.com/binary-husky/chatgpt_academic)讲的很详细了，照做即可。
 
-笔者没有用docker部署，部署过程中只遇到一个问题，换过源后pip找不到高版本的gradio
-![](images/GPT_academic/2023-03-29-01-35-34.png#pic)  
+笔者没有用 docker 部署，部署过程中只遇到一个问题，换过源后 pip 找不到高版本的 gradio
+![](images/GPT_academic/2023-03-29-01-35-34.png#pic)
 
 
 

diff --git a/docs/Blog/Cool/github_profile.md b/docs/Blog/Cool/github_profile.md
@@ -2,23 +2,23 @@
 comments: true
 ---
 
-# 配置Github Profile
+# 配置 Github Profile
 
-!!! abstract 
-    我配置Github主页Profile的方案，灵感来自[:octicons-link-16:Tonycrane的GitHub主页](https://github.com/TonyCrane)
+!!! abstract
+    我配置 Github 主页 Profile 的方案，灵感来自[:octicons-link-16:Tonycrane 的 GitHub 主页](https://github.com/TonyCrane)
 
-## 启用Github主页Profile
-我们先创建一个跟自己账号同名的公开仓库，这是一个特殊的用作主页仓库  
-Github会在主页上显示这一仓库的README文档作为Profile，所以我们只要编写这个README文档即可
+## 启用 Github 主页 Profile
+我们先创建一个跟自己账号同名的公开仓库，这是一个特殊的用作主页仓库
+Github 会在主页上显示这一仓库的 README 文档作为 Profile，所以我们只要编写这个 README 文档即可
 ??? "本人主页预览"
     ![](images/github_profile/2023-03-23-14-49-05.png#pic)
 
 
-## 启用Metrics生成 Profile图片
+## 启用 Metrics 生成 Profile 图片
 
-推荐使用[:octicons-link-16:Metrics](https://github.com/lowlighter/metrics/blob/master/.github/readme/partials/documentation/setup/action.md)来生成好看的Profile
+推荐使用[:octicons-link-16:Metrics](https://github.com/lowlighter/metrics/blob/master/.github/readme/partials/documentation/setup/action.md)来生成好看的 Profile
 
-Metrics使用GitHub Action自动更新，我们只要照着链接里的介绍就可以完成部署。Metrics还支持许多不同的[:octicons-link-16:插件](https://github.com/lowlighter/metrics/blob/master/README.md)，大家可以随意选择自己喜欢的，最后贴上笔者注释的的Action配置和README源代码,欢迎借鉴使用！
+Metrics 使用 GitHub Action 自动更新，我们只要照着链接里的介绍就可以完成部署。Metrics 还支持许多不同的[:octicons-link-16:插件](https://github.com/lowlighter/metrics/blob/master/README.md)，大家可以随意选择自己喜欢的，最后贴上笔者注释的的 Action 配置和 README 源代码，欢迎借鉴使用！
 
 ??? info "参考配置"
 
@@ -34,7 +34,7 @@ Metrics使用GitHub Action自动更新，我们只要照着链接里的介绍就
         # (optional) Run workflow when pushing on master/main
         push: {branches: ["master", "main"]}
         jobs:
-        #generate the left picture 
+        #generate the left picture
         github-left-metrics:
             runs-on: ubuntu-latest
             permissions:
@@ -45,30 +45,30 @@ Metrics使用GitHub Action自动更新，我们只要照着链接里的介绍就
                 uses: lowlighter/metrics@latest
                 with:
                 token: ${{ secrets.METRICS_TOKEN }}
-                
+
                 # the file this action generates
                 filename: matrics-left.svg
                 config_timezone: Asia/Shanghai
-                
-                
+
+
                 # enable plugins
                 plugin_followup: yes
-                
-                
+
+
                 plugin_languages: yes
                 # repositories that wont be accounted
                 plugin_languages_skipped: stormckey/dotfiles
                 plugin_languages_ignored: html, css, ruby, perl, javascript
                 # show the size of source code and percentage of each language
                 plugin_languages_details: bytes-size, percentage
-                
-                
+
+
                 plugin_starlists: yes
                 plugin_starlists_languages: yes
-                
-                
+
+
                 config_order: followup, languages, starlists
-                
+
         github-right-metrics:
             runs-on: ubuntu-latest
             permissions:
@@ -77,27 +77,27 @@ Metrics使用GitHub Action自动更新，我们只要照着链接里的介绍就
             - name: right
                 uses: lowlighter/metrics@latest
                 with:
-                #disable the basic metrics 
+                #disable the basic metrics
                 base: ""
                 token: ${{ secrets.METRICS_TOKEN }}
                 filename: matrics-right.svg
                 config_timezone: Asia/Shanghai
-                
+
                 plugin_topics: yes
                 plugin_topics_mode: icons
-                
-                
+
+
                 plugin_isocalendar: yes
-                
-                
+
+
                 plugin_anilist: yes
                 plugin_anilist_user: stormckey
                 plugin_anilist_sections: favorites, characters
-                
-                
+
+
                 config_order: topics, isocalendar, anilist
-                
-                
+
+
         ```
     === "README.md"
 
@@ -121,4 +121,4 @@ Metrics使用GitHub Action自动更新，我们只要照着链接里的介绍就
         </a>
         </p>
 
-        ```
+        ```
diff --git a/docs/Blog/Cool/index.md b/docs/Blog/Cool/index.md
@@ -4,4 +4,4 @@ comments: true
 # Cool things!
 
 !!! abstract
-    在这里放一些很酷的事情😋
+    在这里放一些很酷的事情😋
diff --git a/docs/Blog/Environment/CLI_tools.md b/docs/Blog/Environment/CLI_tools.md
@@ -2,7 +2,7 @@
 comments: true
 ---
 
-# 我的CLI工具
+# 我的 CLI 工具
 
 !!! abstract
     我在这里列出了我在日常工作中使用的一些 CLI 工具。我会不断更新这个列表。
@@ -19,4 +19,4 @@ comments: true
 - bat
 - httpie
 - hyperfine
-- fzf
+- fzf
diff --git a/docs/Blog/Environment/Mac_VSC_DEBUG.md b/docs/Blog/Environment/Mac_VSC_DEBUG.md
@@ -1,97 +1,97 @@
 ---
 comments: true
 ---
-# 用Mac的VSCode调试C/C++程序
+# 用 Mac 的 VSCode 调试 C/C++程序
 
 !!! info "环境"
-    MacOS: Ventura 13.2.1  
-    VSCode: 1.76.2 x64  
-    C/C++: 1.14.5  
-    CodeLLDB: 1.8.0  
-    Code Runner: 0.12.0  
+    MacOS: Ventura 13.2.1
+    VSCode: 1.76.2 x64
+    C/C++: 1.14.5
+    CodeLLDB: 1.8.0
+    Code Runner: 0.12.0
 
 ## C/C++
 
-这是一个VSCode插件，启用后，会在VSCode中添加C/C++的语法高亮、代码提示、代码跳转等功能。
-同时右上角出现如下图标：  
+这是一个 VSCode 插件，启用后，会在 VSCode 中添加 C/C++的语法高亮、代码提示、代码跳转等功能。
+同时右上角出现如下图标：
 ![](images/Mac_VSC_DEBUG/2023-04-05-23-25-33.png#pic)
 
-选择run的话，插件就会接着让我们选择使用的编译器
+选择 run 的话，插件就会接着让我们选择使用的编译器
 ![](images/Mac_VSC_DEBUG/2023-04-05-23-26-52.png#pic)
 
-比如我选择clang++，那么插件就会在当前工作区下自动生成相应的配置文件，并开始运行。
+比如我选择 clang++，那么插件就会在当前工作区下自动生成相应的配置文件，并开始运行。
 
-对于调试，很遗憾的是，我们的程序是运行在Debug Console中的，而不是终端中，运行在debug console中的问题是没有stdin让我们输入。
+对于调试，很遗憾的是，我们的程序是运行在 Debug Console 中的，而不是终端中，运行在 debug console 中的问题是没有 stdin 让我们输入。
 
-经过查询，发现Mac上C/C++插件不支持debugger运行在内置终端中，setting里也没有修改选项，只能运行在debug console或者外部终端。详见[:octicons-link-16:官网](https://code.visualstudio.com/docs/cpp/launch-json-reference)
+经过查询，发现 Mac 上 C/C++插件不支持 debugger 运行在内置终端中，setting 里也没有修改选项，只能运行在 debug console 或者外部终端。详见[:octicons-link-16:官网](https://code.visualstudio.com/docs/cpp/launch-json-reference)
 ![](images/Mac_VSC_DEBUG/2023-04-05-23-32-55.png#pic)
 
 
-如果希望在外部终端运行进行输入的话，我们要在launch.json中配置。注意,当前版本默认配置文件只会生成task.json,没有launch.json：
+如果希望在外部终端运行进行输入的话，我们要在 launch.json 中配置。注意，当前版本默认配置文件只会生成 task.json,没有 launch.json：
 ![](images/Mac_VSC_DEBUG/2023-04-05-23-34-15.png#pic)
 
-那我们就先介绍一下task.json.这里的一些参数是可以修改的，比如args，就是编译时的参数，其中`-g`参数，会让编译器生成调试信息，这样才能进行debug。还有cwd参数，运行程序的文件夹位置，如果不写的话，就会默认在当前工作区的根目录下运行，而非程序所在目录，这在一些打开文件的操作上可能会导致问题。最后注意一下label，我们可以在别的配置文件中通过这个label来调用这个task。
+那我们就先介绍一下 task.json.这里的一些参数是可以修改的，比如 args，就是编译时的参数，其中`-g`参数，会让编译器生成调试信息，这样才能进行 debug。还有 cwd 参数，运行程序的文件夹位置，如果不写的话，就会默认在当前工作区的根目录下运行，而非程序所在目录，这在一些打开文件的操作上可能会导致问题。最后注意一下 label，我们可以在别的配置文件中通过这个 label 来调用这个 task。
 
-我们新建一个配置文件launch.json：选择侧栏的debug图标，点击`create a launch.json file`:
+我们新建一个配置文件 launch.json：选择侧栏的 debug 图标，点击`create a launch.json file`:
 ![](images/Mac_VSC_DEBUG/2023-04-05-23-38-02.png#pic)
 
-刚开始是空的，什么都没有。点击右下角的`Add Configuration`，就有一些选项，这里有插件为我们准备的默认模版，我们选择`C/C++ lldb（启动）`，意思是C/C++插件提供的，启动一个新的可执行文件并对其debug的配置，选择附加的话是附加到一个已经在执行的进程上的:
+刚开始是空的，什么都没有。点击右下角的`Add Configuration`，就有一些选项，这里有插件为我们准备的默认模版，我们选择`C/C++ lldb（启动）`，意思是 C/C++插件提供的，启动一个新的可执行文件并对其 debug 的配置，选择附加的话是附加到一个已经在执行的进程上的：
 ![](images/Mac_VSC_DEBUG/2023-04-05-23-39-19.png#pic)
 
 默认的模板长这个样子：
 ![](images/Mac_VSC_DEBUG/2023-04-05-23-40-26.png#pic)
 
-这并不能直接使用，首先修改program为
+这并不能直接使用，首先修改 program 为
 ```
 "program": "${workspaceFolder}/${fileBasenameNoExtension}",
 ```
 ，这样他运行的就会是当前目录下的当前文件（一般就是光标悬停的那个文件）同名的可执行文件（意思就是没后缀），如果我们编译出来的可执行文件叫做`a.out`，这个配置就不适用（会调用`a`），请在配置中修改为`/a.out`或者让编译出来的可执行文件名为`a`。
 
-新加一列`preLaunchTask`，值就是之前task.json上的label，这样就会在运行前可执行文件前先运行task编译当前文件（这样比较方便，自动把最新的源代码编译,要多文件编译的话也在task设置。如果不使用task手动编译的话，记得加上-g）。最后，我们要把`"externalConsole": false,`改为`"externalConsole": true,`，这样就会在外部终端中运行了。
+新加一列`preLaunchTask`，值就是之前 task.json 上的 label，这样就会在运行前可执行文件前先运行 task 编译当前文件（这样比较方便，自动把最新的源代码编译，要多文件编译的话也在 task 设置。如果不使用 task 手动编译的话，记得加上-g）。最后，我们要把`"externalConsole": false,`改为`"externalConsole": true,`，这样就会在外部终端中运行了。
 ![](images/Mac_VSC_DEBUG/2023-04-05-23-45-03.png#pic)
 
-笔者到这一步就可以在外部终端debug啦，也可以在watch窗口执行命令来监视变量，如全局变量一类的，但是C/C++对一些类型的变量的监视支持不是很好，比如说string：
+笔者到这一步就可以在外部终端 debug 啦，也可以在 watch 窗口执行命令来监视变量，如全局变量一类的，但是 C/C++对一些类型的变量的监视支持不是很好，比如说 string：
 ![](images/Mac_VSC_DEBUG/2023-04-05-23-47-26.png#pic)
 监视信息就是一坨。
 
 ## Code Runner
 
-另一个VSCode插件，启用后右上角又会多一个标：
+另一个 VSCode 插件，启用后右上角又会多一个标：
 ![](images/Mac_VSC_DEBUG/2023-04-05-23-49-08.png#pic)
 
 这个是可以跑在内置终端里的：
 ![](images/Mac_VSC_DEBUG/2023-04-05-23-49-51.png#pic)
 
 ## CodeLLDB 👍
 
-这个插件也可以进行debug，我感觉比C/C++好用多了。
+这个插件也可以进行 debug，我感觉比 C/C++好用多了。
 
-启用插件后，我们在launch.json中可选配置就多了几个，我们使用`CodeLLDB (launch)`模板：
+启用插件后，我们在 launch.json 中可选配置就多了几个，我们使用`CodeLLDB (launch)`模板：
 ![](images/Mac_VSC_DEBUG/2023-04-05-23-51-28.png#pic)
 
 同样稍微修改：
 ![](images/Mac_VSC_DEBUG/2023-04-05-23-52-33.png#pic)
 
-回到侧边栏debug模块，选择新的启动配置（这里选的是launch.json里写好的几个配置）：
+回到侧边栏 debug 模块，选择新的启动配置（这里选的是 launch.json 里写好的几个配置）：
 ![](images/Mac_VSC_DEBUG/2023-04-05-23-53-05.png#pic)
 
-这会在我们启用debug的时候去launch.json里面找我们指定的配置，然后进行debug。
+这会在我们启用 debug 的时候去 launch.json 里面找我们指定的配置，然后进行 debug。
 
-!!! warning "有时候debug弹出奇怪的报错，是因为当前打开的是配置文件，试图对launch.json进行debug，所以报错了。我们打开要debug的源代码文件就好了。"
+!!! warning "有时候 debug 弹出奇怪的报错，是因为当前打开的是配置文件，试图对 launch.json 进行 debug，所以报错了。我们打开要 debug 的源代码文件就好了。"
 
 CodeLLDB 可以使用内置终端：
 ![](images/Mac_VSC_DEBUG/2023-04-06-00-00-07.png#pic)
 
 可以在监视里直接用变量名监视变量：
 ![](images/Mac_VSC_DEBUG/2023-04-06-00-00-37.png#pic)
 
-可以在debug console中输入命令：
+可以在 debug console 中输入命令：
 ![](images/Mac_VSC_DEBUG/2023-04-06-00-01-06.png#pic)
 
 变量里的字符串支持也好一些：
 ![](images/Mac_VSC_DEBUG/2023-04-06-00-01-51.png#pic)
 
 [:octicons-link-16:这里](https://github.com/vadimcn/codelldb/blob/master/MANUAL.md)还有官方文档，可以看看。
 
-!!! info "手动创建一个task.json"
-    在菜单 terminal > Configure Tasks 选择C/C++来生成模板
+!!! info "手动创建一个 task.json"
+    在菜单 terminal > Configure Tasks 选择 C/C++来生成模板
diff --git a/docs/Blog/Environment/VSCode-Markdown.md b/docs/Blog/Environment/VSCode-Markdown.md
@@ -2,57 +2,57 @@
 comments: true
 ---
 
-# 在VSCode上写Markdown
+# 在 VSCode 上写 Markdown
 
 ## 起步
-首先启用以下的两个插件，就可以开始写markdown，并在右侧预览了
+首先启用以下的两个插件，就可以开始写 markdown，并在右侧预览了
 
 ![](images/VSCode-markdown/2023-03-23-14-24-20.png#pic)
 ??? info "效果图"
     ![](images/VSCode-markdown/2023-03-23-14-25-15.png#pic)
     ![](images/VSCode-markdown/2023-03-23-14-32-24.png#pic)
 注意预览需要在编辑器右上角点击预览按钮开启或者使用快捷键
 
-如果需要保存成PDF或者别的格式，在预览界面右键就好，Chrome一栏的三个选项都是不需要额外安装的：
+如果需要保存成 PDF 或者别的格式，在预览界面右键就好，Chrome 一栏的三个选项都是不需要额外安装的：
 
 ![](images/VSCode-markdown/2023-03-23-14-34-26.png#pic)
 
 ??? tip "数学公式渲染问题"
-    有时候保存成PDF时会发现数学公式渲染失败了，调查了一下发现是生成的速度太快了数学公式来不及渲染，调节以下参数可以解决问题：
+    有时候保存成 PDF 时会发现数学公式渲染失败了，调查了一下发现是生成的速度太快了数学公式来不及渲染，调节以下参数可以解决问题：
     ![](images/VSCode-markdown/2023-03-23-14-35-52.png#pic)
 
 ## 快捷地插入图片
 
-就最原教旨主义的插入方式而言，需要把图片保存到指定文件夹，起好名字，再利用`![](url)`格式插入，步骤相当繁琐，跟Word的图片插入完全是两个量级的工作量。
+就最原教旨主义的插入方式而言，需要把图片保存到指定文件夹，起好名字，再利用`![](url)`格式插入，步骤相当繁琐，跟 Word 的图片插入完全是两个量级的工作量。
 
 推荐使用**Paste Image**插件：
 ![](images/VSCode-markdown/2023-03-23-14-37-41.png#pic)
 
 修改如下的设置：
 ![](images/VSCode-markdown/2023-03-23-14-38-36.png#pic)
-这会将图片插入到当前md文件下的images/mdfilename/time.png位置。
+这会将图片插入到当前 md 文件下的 images/mdfilename/time.png 位置。
 
-用系统自带的截屏工具截屏到粘贴板后Command+Option+v即可存入文件夹并自动引用正确的路径。
+用系统自带的截屏工具截屏到粘贴板后 Command+Option+v 即可存入文件夹并自动引用正确的路径。
 ??? tip "设置默认图片样式"
-    本人使用mkdocs for material搭建此网页，可以给此插件添加的图片添加统一样式：
+    本人使用 mkdocs for material 搭建此网页，可以给此插件添加的图片添加统一样式：
 
-    -  设置css：比如阴影加圆角
+    -  设置 css：比如阴影加圆角
         ``` css
         img[src*="pic"] {
         box-shadow: 4px 4px 15px #666;
         border-radius: 10px;
         }
         ```
-    - 在mkdocs.yml添加css作为额外css：
+    - 在 mkdocs.yml 添加 css 作为额外 css：
         ``` yaml
         extra_css:
         - css/extra.css
-        ``` 
-    - 设置Paste Imgae自动添加后缀：
+        ```
+    - 设置 Paste Imgae 自动添加后缀：
         ``` json
         "pasteImage.suffix": "#pic"
         ```
     - 可以添加多个样式，并改变#后的名称来切换
 
 
-    
+
diff --git a/docs/Blog/Environment/VSCode_conda.md b/docs/Blog/Environment/VSCode_conda.md
@@ -1,16 +1,16 @@
 ---
 comments: true
 ---
-# 在VSCode中使用conda的虚拟环境问题
+# 在 VSCode 中使用 conda 的虚拟环境问题
 
-最近开始使用conda，试图在VSCode终端里切换虚拟环境，命令行提示已经切换，但是python环境实际上没有变。  
+最近开始使用 conda，试图在 VSCode 终端里切换虚拟环境，命令行提示已经切换，但是 python 环境实际上没有变。
 解决方案如下：
 
-1. 快捷键`command shift p`，搜索settings，打开user settings json
+1. 快捷键`command shift p`，搜索 settings，打开 user settings json
 2. 加入如下内容：
   ```
       "terminal.integrated.env.osx": {
         "PATH": ""
     },
   ```
-3. 重启VSCode即可
+3. 重启 VSCode 即可
diff --git a/docs/Blog/Environment/index.md b/docs/Blog/Environment/index.md
@@ -5,5 +5,5 @@ comments: true
 # Environment
 
 !!! danger
-    谁还没有被环境折腾过呢😇  
-    我们配环境的宗旨是：能跑就行！
+    谁还没有被环境折腾过呢😇
+    我们配环境的宗旨是：能跑就行！