Skip to content

Commit 1aa620d

Browse files
committed
docs: update readme
1 parent 1323775 commit 1aa620d

File tree

1 file changed

+17
-18
lines changed

1 file changed

+17
-18
lines changed

README.md

+17-18
Original file line numberDiff line numberDiff line change
@@ -2,26 +2,25 @@
22
LapisCV
33
</h1>
44
<p align="center">
5-
📃 开箱即用的 Obsidian / Typora / VSCode 简历
5+
📃 开箱即用的 Markdown 简历,支持 VSCode / Obsidian / Typora
66
</p>
77
<div align="center">
8-
<img alt="Release" src="https://img.shields.io/github/v/release/BingyanStudio/LapisCV?style=flat-square">
8+
<img alt="Release" src="https://img.shields.io/github/v/release/BingyanStudio/LapisCV?style=flat-square&color=1694b6">
99
&nbsp;
10-
<img alt="Stars" src="https://img.shields.io/github/stars/BingyanStudio/LapisCV?style=flat-square">
10+
<img alt="Stars" src="https://img.shields.io/github/stars/BingyanStudio/LapisCV?style=flat-square&color=2f86d2">
1111
&nbsp;
12-
<img alt="Downloads" src="https://img.shields.io/github/downloads/BingyanStudio/LapisCV/total?style=flat-square&color=007ec7">
12+
<img alt="Downloads" src="https://img.shields.io/github/downloads/BingyanStudio/LapisCV/total?style=flat-square&color=5e76c3">
1313
</div><br>
1414

1515
基于 Markdown 格式,易于编辑,所见即所得。风格简洁正式,支持多页,适用于大部分求职 / 求学场景。
1616

1717
### 预览
1818

19-
- Obsidian / Typora 编辑页
19+
- 编辑页
2020

2121
<div align="center">
2222
<div>
2323
<img src=".assets/screenshot-obsidian.png" width="90%" />
24-
<img src=".assets/screenshot.png" width="90%" />
2524
</div>
2625
</div>
2726

@@ -34,10 +33,6 @@
3433

3534
### 安装与使用
3635

37-
#### Obsidian
38-
39-
下载 [Release](https://github.com/BingyanStudio/LapisCV/releases/latest),将 `lapis-cv-obsidian` 目录作为 Vault 在 Obsidian 打开,编辑 template 并导出 PDF 文件即可。
40-
4136
#### Typora
4237

4338
1. 下载 [Release](https://github.com/BingyanStudio/LapisCV/releases/latest),设置 Lapis Cv 作为主题:
@@ -50,12 +45,16 @@
5045

5146
#### VSCode
5247

53-
1. 下载 [Release](https://github.com/BingyanStudio/LapisCV/releases/latest) 并解压至某一文件夹
48+
1. 下载 [Release](https://github.com/BingyanStudio/LapisCV/releases/latest) 并解压
5449
2. 在 VSCode 中打开该文件夹,并安装插件 [Markdown PDF](https://marketplace.visualstudio.com/items?itemName=yzane.markdown-pdf)
55-
3. 打开模版文件 [template.md](vscode/template.md) 进行内容编辑,右键选择 Markdown PDF - Export (pdf) 即可导出 PDF 文件。
50+
3. 打开模版文件 [template.md](vscode/template.md) 进行内容编辑,右上角点击 Open Preview 图标可进行实时预览。右键选择 Markdown PDF - Export (pdf) 即可导出 PDF 文件。
5651

5752
需要注意,VSCode 中安装的其他插件可能会影响预览显示效果,若预览效果与生成 PDF 中效果不一致,请检查是否有插件影响。
5853

54+
#### Obsidian
55+
56+
下载 [Release](https://github.com/BingyanStudio/LapisCV/releases/latest),将 `lapis-cv-obsidian` 目录作为 Vault 在 Obsidian 打开,编辑 template 并导出 PDF 文件即可。
57+
5958
### 格式
6059

6160
- 一级标题:姓名块
@@ -72,10 +71,6 @@
7271

7372
支持自定义样式,便于适配不同体量的单页内容 & 根据喜好调整样式细节。
7473

75-
#### Obsidian
76-
77-
可在 设置 - 外观 中快速更换主题色与字体,其他样式在 `.obsidian/themes/lapis-cv.css` 修改。
78-
7974
#### Typora
8075

8176
修改主题文件夹中的 `lapis-cv.css` 并重启 Typora。
@@ -118,7 +113,7 @@
118113

119114
修改 `lapis-cv.css` 即可。具体样式可参考上述 Typora 部分。
120115

121-
但页边距需要在 VSCode 设置中修改:
116+
其中页边距需要在 VSCode 设置中修改:
122117

123118
- 直接修改 .vscode/settings.json 文件中的 markdown-pdf.margin 相关项。
124119

@@ -127,4 +122,8 @@
127122
1. 打开 VSCode 设置,选中 Workspace 标签页。
128123
2. 搜索 Markdown-pdf › Margin,并修改四边边距。
129124

130-
无需重启 VSCode,重新生成 PDF 即可生效。
125+
无需重启 VSCode,重新生成 PDF 即可生效。
126+
127+
#### Obsidian
128+
129+
可在 设置 - 外观 中快速更换主题色与字体,其他样式在 `.obsidian/themes/lapis-cv.css` 修改,具体样式可参考上述 Typora 部分。

0 commit comments

Comments
 (0)