使用指南
一纸简历根据 markdown 生成 PDF 格式简历,它的语法与 markdown 一致,如果你非常熟悉 markdown,则直接将简历编辑为一份 markdown 即可。
但因为简历的特殊性,因此只支持一些 markdown 的基础语法,同时为了扩展样式的可能性,使其支持 tailwindcss
样式,以及 lucide
的 icon。
基础语法
目前支持以下 Markdown 语法:
- Heading:
#
、##
、###
、####
。将简历名称视为h1
,如# 山月-五年-前端
,专业技能工作经验等视为h2
,如## 专业技能
。 - Code: `javascript`。填写简历中的技术栈,可用该语法。
- list:
+
、-
、1.
。罗列项目经验责任、重难点时可以用列表罗列。 - a:
[shanyue](https://shanyue.tech)
。GitHub、博客、个人项目地址可以使用a
标签。
classname 自动补全
一纸简历接入了 emmet (opens in a new tab),因此你可以快速书写样式,如 text-red-500
、bg-blue-500
等。
当你输入 classname 后,紧跟 command-e
即可自动补全。
.text-center.text-lg<cmd-e>
<div className="text-center text-lg"></div>
tailwindcss 样式
为了扩展简历样式,一纸简历支持 tailwindcss (opens in a new tab) 样式,如 text-red-500
、bg-blue-500
等。
用它实现两栏或者三栏布局很方便。
<!-- 两栏布局 -->
<h3>
<div className="flex justify-between">
<div>山西大学</div>
<div>2009-2013</div>
</div>
</h3>
<!-- 三拦布局 -->
<h3>
<div className="flex justify-between">
<div>山西大学</div>
<div>本科</div>
<div>2009-2013</div>
</div>
</h3>
个人信息居中布局
<div class="mb-2 text-2xl font-bold text-center">
山月-三年-前端工程师
</div>
<div className="text-center">
微信:shanyue-bot |
<span class="icon-phone"></span> 18334567890
</div>
<div className="text-center">
<span class="icon-mail"></span> me@shanyue.tech |
<span class="icon-github"></span> [shfshanyue](https://github.com/shfshanyue) |
<span class="icon-home"></span> <https://shanyue.tech>
</div>
icon 图标
为了扩展简历中图标的样式,一纸简历支持 Lucide Icons (opens in a new tab)。你可以很容易在一纸简历中书写各种图标,如手机、邮箱、GitHub 等。
你只需要找到该 Icon 的名称,然后通过 icon-xxx
的 class 进行引用即可。
示例如下:
# 山月-三年-前端工程师
<span class="icon-message-circle"></span> 微信:shanyue-bot |
<span class="icon-phone"></span> 18334567890 |
<span class="icon-mail"></span> me@shanyue.tech |
<span class="icon-github"></span> [shfshanyue](https://github.com/shfshanyue) |
<span class="icon-home"></span> <https://shanyue.tech>
速查表
元素 | 语法 |
---|---|
Heading | # H1 |
Bold | **bold text** |
Italic | *italicized text* |
Blockquote | > blockquote |
Ordered List | 1. First item |
Unordered List | + First item |
Code | `code` |
Link | [title](https://www.example.com\ (opens in a new tab)) |