Skip to content

Commit

Permalink
docs: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
YiNNx committed Sep 14, 2024
1 parent 1323775 commit 1aa620d
Showing 1 changed file with 17 additions and 18 deletions.
35 changes: 17 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,26 +2,25 @@
LapisCV
</h1>
<p align="center">
📃 开箱即用的 Obsidian / Typora / VSCode 简历
📃 开箱即用的 Markdown 简历,支持 VSCode / Obsidian / Typora
</p>
<div align="center">
<img alt="Release" src="https://img.shields.io/github/v/release/BingyanStudio/LapisCV?style=flat-square">
<img alt="Release" src="https://img.shields.io/github/v/release/BingyanStudio/LapisCV?style=flat-square&color=1694b6">
&nbsp;
<img alt="Stars" src="https://img.shields.io/github/stars/BingyanStudio/LapisCV?style=flat-square">
<img alt="Stars" src="https://img.shields.io/github/stars/BingyanStudio/LapisCV?style=flat-square&color=2f86d2">
&nbsp;
<img alt="Downloads" src="https://img.shields.io/github/downloads/BingyanStudio/LapisCV/total?style=flat-square&color=007ec7">
<img alt="Downloads" src="https://img.shields.io/github/downloads/BingyanStudio/LapisCV/total?style=flat-square&color=5e76c3">
</div><br>

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

### 预览

- Obsidian / Typora 编辑页
- 编辑页

<div align="center">
<div>
<img src=".assets/screenshot-obsidian.png" width="90%" />
<img src=".assets/screenshot.png" width="90%" />
</div>
</div>

Expand All @@ -34,10 +33,6 @@

### 安装与使用

#### Obsidian

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

#### Typora

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

#### VSCode

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

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

#### Obsidian

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

### 格式

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

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

#### Obsidian

可在 设置 - 外观 中快速更换主题色与字体,其他样式在 `.obsidian/themes/lapis-cv.css` 修改。

#### Typora

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

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

但页边距需要在 VSCode 设置中修改:
其中页边距需要在 VSCode 设置中修改:

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

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

无需重启 VSCode,重新生成 PDF 即可生效。
无需重启 VSCode,重新生成 PDF 即可生效。

#### Obsidian

可在 设置 - 外观 中快速更换主题色与字体,其他样式在 `.obsidian/themes/lapis-cv.css` 修改,具体样式可参考上述 Typora 部分。

0 comments on commit 1aa620d

Please sign in to comment.