Skip to content

Commit 2afb486

Browse files
doc: update README.md
* doc: update README.md Add "border" for images. It would be better to shrink the images. * doc: add height style for images * docs: remove vh unit in img height property Co-authored-by: laggage <38829279+laggage@users.noreply.github.com>
1 parent 67ea3f4 commit 2afb486

File tree

1 file changed

+59
-52
lines changed

1 file changed

+59
-52
lines changed

README.md

Lines changed: 59 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -2,113 +2,120 @@
22

33
- [简介](#简介)
44
- [主要功能](#主要功能)
5-
- [登录/授权](#登录授权)
6-
- [将本地markdown文件发布到博客园](#将本地markdown文件发布到博客园)
7-
- [博客园博文列表](#博客园博文列表)
8-
- [将本地文件关联到博客园博文](#将本地文件关联到博客园博文)
9-
- [拉取远程博文内容更新本地文件](#拉取远程博文内容更新本地文件)
10-
- [图片上传](#图片上传)
11-
- [博文分类管理](#博文分类管理)
12-
- [导出pdf](#导出pdf)
13-
- [博文设置面板](#博文设置面板)
14-
- [vscode版本要求](#vscode版本要求)
5+
- [登录 / 授权](#登录--授权)
6+
- [将本地 markdown 文件发布到博客园](#将本地-markdown-文件发布到博客园)
7+
- [博客园博文列表](#博客园博文列表)
8+
- [将本地文件关联到博客园博文](#将本地文件关联到博客园博文)
9+
- [拉取远程博文内容更新本地文件](#拉取远程博文内容更新本地文件)
10+
- [图片上传](#图片上传)
11+
- [博文分类管理](#博文分类管理)
12+
- [导出 pdf](#导出-pdf)
13+
- [博文设置面板](#博文设置面板)
14+
- [vscode 版本要求](#vscode-版本要求)
1515
- [插件设置](#插件设置)
1616

1717
## 简介
1818

19-
博客园vscode插件, 主要功能是将本地markdown文件对应到博文园中博文, 从而让vscode用户可以一键发布markdown博文到博客园.
19+
博客园 vscode 插件,主要功能是将本地 markdown 文件对应到博文园中博文,从而让 vscode 用户可以一键发布 markdown 博文到博客园。
2020

2121
## 主要功能
2222

23-
### 登录/授权
23+
### 登录 / 授权
2424

25-
要使用本插件发布/修改博文, 需要先进行登录或授权操作.
25+
要使用本插件发布 / 修改博文,需要先进行登录或授权操作
2626

27-
![](https://img2020.cnblogs.com/blog/1596066/202112/1596066-20211228125556260-986735114.png)
27+
<kbd><img src="https://img2020.cnblogs.com/blog/1596066/202112/1596066-20211228125556260-986735114.png" height="150"></kbd>
2828

29-
### 将本地markdown文件发布到博客园
29+
### 将本地 markdown 文件发布到博客园
3030

31-
![](https://img2020.cnblogs.com/blog/1596066/202112/1596066-20211228130156308-187058889.png)
31+
<kbd><img src="https://img2020.cnblogs.com/blog/1596066/202112/1596066-20211228130156308-187058889.png" height="550"></kbd>
3232

33-
![](https://img2020.cnblogs.com/blog/1596066/202112/1596066-20211228130228248-172977703.png)
33+
<kbd><img src="https://img2020.cnblogs.com/blog/1596066/202112/1596066-20211228130228248-172977703.png" height="550"></kbd>
3434

35-
若本地文件已经关联到一篇博客园博文, 那么会直接更新这篇博文.
35+
若本地文件已经关联到一篇博客园博文那么会直接更新这篇博文
3636

37-
也通过vscode的`Command Palette`(唤起`Command Palette`快捷键, windows:`ctrl+shift+p`, macos: `command+shift+p`)调用`Cnblogs: 保存到博客园`命令, 将当前正在编辑的markdown文件保存到博客园上
37+
也通过 vscode 的 `Command Palette`(唤起 `Command Palette` 快捷键,windows`ctrl+shift+p`macos`command+shift+p`)调用 `Cnblogs: 保存到博客园`命令,将当前正在编辑的 markdown 文件保存到博客园上
3838

39-
![image](https://img2022.cnblogs.com/blog/1596066/202203/1596066-20220323151757542-155709896.png)
39+
<kbd><img src="https://img2022.cnblogs.com/blog/1596066/202204/1596066-20220415194545998-874211959.png" height="550"></kbd>
4040

4141
### 博客园博文列表
4242

43-
当点击列表中的博文时, 会自动将博文内容下载到工作空间一个本地文件中(此时这个本地文件就关联到了这篇博文), 完成编辑后可以再将本地的内容保存到博客园博文
43+
当点击列表中的博文时会自动将博文内容下载到工作空间一个本地文件中此时这个本地文件就关联到了这篇博文),完成编辑后可以再将本地的内容保存到博客园博文
4444

45-
![img](https://img2020.cnblogs.com/blog/3/202112/3-20211227184342642-1938639868.png)
45+
<kbd><img src="https://img2020.cnblogs.com/blog/3/202112/3-20211227184342642-1938639868.png" height="550"></kbd>
4646

4747
### 将本地文件关联到博客园博文
4848

49-
一个本地文件可以关联到一篇博客园博文, 本地文件必须在`vscode-cnb.workspace`配置的工作目录中
49+
一个本地文件可以关联到一篇博客园博文本地文件必须在 `vscode-cnb.workspace` 配置的工作目录中
5050

51-
![](https://img2020.cnblogs.com/blog/1596066/202112/1596066-20211228130049842-409512486.png)
51+
<kbd><img src="https://img2020.cnblogs.com/blog/1596066/202112/1596066-20211228130049842-409512486.png" height="550"></kbd>
5252

5353
### 拉取远程博文内容更新本地文件
5454

55-
本地文件和博文关联后, 如果通过博客后台更新了这篇博文, 此时本地文件是不会自动更新的, 但是可以通过`Cnblogs: 拉取远程更新`命令来更新本地博文
55+
本地文件和博文关联后如果通过博客后台更新了这篇博文此时本地文件是不会自动更新的但是可以通过 `Cnblogs: 拉取远程更新`命令来更新本地博文
5656

57-
可以在下面这些地方可以调用`Cnblogs: 拉取远程更新`
57+
可以在下面这些地方可以调用 `Cnblogs: 拉取远程更新`
5858

59-
- 博客园随笔列表视图中的博文的上下文菜单`拉取远程更新`(仅已关联本地文件的博文)
60-
![img](https://img2022.cnblogs.com/blog/1596066/202204/1596066-20220401183632997-360803717.png)
61-
- 编辑器上下文菜单中的`拉取远程更新`(仅针对markdown文件)
62-
![img](https://img2022.cnblogs.com/blog/1596066/202204/1596066-20220401183816920-413500619.png)
63-
- 文件浏览器上下文菜单中的`拉取远程更新`(仅针对markdown文件)
64-
![img](https://img2022.cnblogs.com/blog/1596066/202204/1596066-20220401183918962-2083221618.png)
65-
- vscode命令面板`Cnblogs: 拉取远程更新`, 此时会尝试去寻找当前正在编辑的文件对其进行更新
66-
![img](https://img2022.cnblogs.com/blog/1596066/202204/1596066-20220401184013947-1481430186.png)
59+
- 博客园随笔列表视图中的博文的上下文菜单`拉取远程更新`(仅已关联本地文件的博文)
60+
61+
<kbd><img src="https://img2022.cnblogs.com/blog/1596066/202204/1596066-20220415195826898-1477642941.png" height="350"></kbd>
6762

68-
在更新本地文件之前会弹出确认对话框, 因为此操作会覆盖本地文件的内容, 所以请谨慎使用.
63+
- 编辑器上下文菜单中的`拉取远程更新`(仅针对 markdown 文件)
64+
65+
<kbd><img src="https://img2022.cnblogs.com/blog/1596066/202204/1596066-20220415195920100-1395377363.png" height="550"></kbd>
66+
67+
- 文件浏览器上下文菜单中的`拉取远程更新`(仅针对 markdown 文件)
68+
69+
<kbd><img src="https://img2022.cnblogs.com/blog/1596066/202204/1596066-20220401183918962-2083221618.png" height="550"></kbd>
70+
71+
- vscode 命令面板 `Cnblogs: 拉取远程更新`,此时会尝试去寻找当前正在编辑的文件对其进行更新
72+
73+
<kbd><img src="https://img2022.cnblogs.com/blog/1596066/202204/1596066-20220401184013947-1481430186.png" height="550"></kbd>
74+
75+
在更新本地文件之前会弹出确认对话框,因为此操作会覆盖本地文件的内容,所以请谨慎使用。
6976

7077
### 图片上传
7178

72-
当vscode处于配置好的`vscode-cnb`工作空间时, 可以通过快捷键, 上下文菜单, 编辑器工具栏等方式上传本地或剪贴板中的图片到博客园
79+
当 vscode 处于配置好的 `vscode-cnb` 工作空间时,可以通过快捷键上下文菜单编辑器工具栏等方式上传本地或剪贴板中的图片到博客园
7380

74-
![demo-upload-clipboard-image](https://img2020.cnblogs.com/blog/3/202112/3-20211223133219376-311354679.gif)
81+
<kbd><img src="https://img2020.cnblogs.com/blog/3/202112/3-20211223133219376-311354679.gif" height="550"></kbd>
7582

7683
### 博文分类管理
7784

78-
支持新建, 删除(可批量操作), 修改博客园博文分类
85+
支持新建,删除(可批量操作),修改博客园博文分类
7986

80-
![](https://img2020.cnblogs.com/blog/1596066/202112/1596066-20211228130552877-1788018336.png)
87+
<kbd><img src="https://img2020.cnblogs.com/blog/1596066/202112/1596066-20211228130552877-1788018336.png" height="300"></kbd>
8188

82-
### 导出pdf
89+
### 导出 pdf
8390

84-
支持将博文导出为pdf格式的文件到本地, 此功能依赖于[Chromium](https://www.chromium.org/chromium-projects/), vscode-cnb默认会先从本地寻找是否有已安装的Chrome或基于Chromium的Edge浏览器, 若有的话则会直接使用本地的Chrome或基于Chromium的Edge; 若未找到, 那么会提示用户手动选择本地的Chromium或其他基于Chromium的浏览器
91+
支持将博文导出为 pdf 格式的文件到本地,此功能依赖于 [Chromium](https://www.chromium.org/chromium-projects/)vscode-cnb 默认会先从本地寻找是否有已安装的 Chrome 或基于 Chromium 的 Edge 浏览器,若有的话则会直接使用本地的 Chrome 或基于 Chromium 的 Edge; 若未找到,那么会提示用户手动选择本地的 Chromium 或其他基于 Chromium 的浏览器
8592

86-
![image](https://img2022.cnblogs.com/blog/1596066/202203/1596066-20220323135717910-1090211493.png)
93+
<kbd><img src="https://img2022.cnblogs.com/blog/1596066/202203/1596066-20220323135717910-1090211493.png" height="550"></kbd>
8794

88-
也可以在vscode的设置中手动配置**Chromium或其他基于Chromium的浏览器的可执行文件路径**, 这个路径针对windows和macos是不同的两个配置, 可以根据自己使用的系统进行配置
95+
也可以在 vscode 的设置中手动配置 **Chromium 或其他基于 Chromium 的浏览器的可执行文件路径**,这个路径针对 windows 和 macos 是不同的两个配置,可以根据自己使用的系统进行配置
8996

90-
![image](https://img2022.cnblogs.com/blog/1596066/202203/1596066-20220323135918858-1619509502.png)
97+
<kbd><img src="https://img2022.cnblogs.com/blog/1596066/202203/1596066-20220323135918858-1619509502.png" height="350"></kbd>
9198

9299
支持多选
93100

94-
![image](https://img2022.cnblogs.com/blog/1596066/202203/1596066-20220323140426961-1518402131.png)
101+
<kbd><img src="https://minio.mytechsky.top/blog/images/2022041520261503-1596066-20220323140426961-1518402131.png"></kbd>
95102

96103
### 博文设置面板
97104

98-
首次发布本地markdown文件到博客园时, 会打开博文设置面板允许编辑博文相关的设置
105+
首次发布本地 markdown 文件到博客园时,会打开博文设置面板允许编辑博文相关的设置
99106

100-
![image](https://img2022.cnblogs.com/blog/1596066/202203/1596066-20220331112748377-737262324.png)
107+
<kbd><img src="https://img2022.cnblogs.com/blog/1596066/202203/1596066-20220331112748377-737262324.png" height="550"></kbd>
101108

102-
同时, 也可以在博客园随笔列表视图, 文件列表视图和markdown编辑器中上下文菜单中可以通过**博文设置**命令打开博文设置面板
109+
同时也可以在博客园随笔列表视图,文件列表视图和 markdown 编辑器中上下文菜单中可以通过**博文设置**命令打开博文设置面板
103110

104-
![image](https://img2022.cnblogs.com/blog/1596066/202203/1596066-20220331113211016-1457564407.png)
111+
<kbd><img src="https://img2022.cnblogs.com/blog/1596066/202203/1596066-20220331113211016-1457564407.png" height="550"></kbd>
105112

106-
## vscode版本要求
113+
## vscode 版本要求
107114

108115
\>=1.62.0
109116

110117
## 插件设置
111118

112-
* `workspace`: `vscode-cnb`需要用到的一个工作空间, `vscode-cnb`只有检测到vscode处于此目录下才会生效, 默认会使用`~/Documents/Cnblogs`作为工作空间
119+
* `workspace``vscode-cnb` 需要用到的一个工作空间,`vscode-cnb` 只有检测到 vscode 处于此目录下才会生效,默认会使用 `~/Documents/Cnblogs` 作为工作空间
113120

114-
![img](https://img2020.cnblogs.com/blog/3/202112/3-20211227183958436-462553661.png)
121+
<kbd><img src="https://img2020.cnblogs.com/blog/3/202112/3-20211227183958436-462553661.png" height="150"></kbd>

0 commit comments

Comments
 (0)