kn134133 / markdown-resume-to-pdf

Resume builder based on markdown syntax（简历制作工具）.

markdown-resume-to-pdf

中文 | English

在线编辑地址 1 在线编辑地址 2

声明：此项目发布于 Github/Gitee，基于 MIT 协议，免费且作为开源学习使用。并且不会有任何形式的卖号、付费服务、讨论群、讨论组等行为。谨防受骗。

简历模板 & 默认主题

简历编辑器 & 暗黑主题

• 介绍

• 待实现功能

• 前置要求

• Node

• PNPM

• 安装依赖

• 测试环境运行

• 环境变量

• 打包

• 常见问题

• 参与贡献

• 赞助

介绍

一款 markdown 简历制作工具，可以把你编写的简历转换为 PDF，支持多种模板，完全免费。

优势：

1. 传统简历制作方式通过 UI 界面填写表单/拖拽的方式生成简历，过程较为复杂繁琐，基于 markdown 编写的简历排版会非常易于扩展，且操作方便，在 markdown 常用语法的基础上还新增了多列布局（Flex）语法，使用方式稍后会介绍。
2. 对简历的某个设计不满意，完全可以通过自己 DIY 去更改简历搭配，大大提升了简历的可扩展性。
3. 简历智能一页，解决了简历内容过少或过多引发的尴尬境地。
4. 提供简历社区可分享求职过程中的经历（初衷是建立一个简历与面经相结合的平台）。

待实现功能

[✓] 移动端适配

[✓] 模板制作（持续更新...）

前置要求

启动项目前所需要的环境

Node

node 需要 ^16 || ^18 || ^19，建议使用 nvm 可管理本地多个 node 版本

node -v

PNPM

如果你没有安装过 pnpm

npm install pnpm -g

安装依赖

进入文件夹 /markdown-resume 运行以下命令

pnpm install

测试环境运行

pnpm dev

环境变量

• VITE_BASE_URL 后端请求地址，可选（对接社区 API，如果不想接入社区功能就没必要填写）

打包

pnpm build

最后将dist目录部署到服务器即可

常见问题

Q: 怎么编写多列布局？

A:

::: start content ::: content ::: content ::: end
<!-- 上面的语法将会被转化为下面的`HTML`结构(三列布局) -->
<div class="flex-layout">
  <div class="flex-layout-item">content</div>
  <div class="flex-layout-item">content</div>
  <div class="flex-layout-item">content</div>
  <div></div>
</div>

Q: 怎么新增 icon 图标？

A:

icon:github
<!-- 上面的语法将会被转化为下面的`HTML`结构 -->
<i class="iconfont icon-github"></i>

Q: 如何新增空格？

A: 在编辑器中编写 

Q: 如何编写个人信息栏？

A:

::: headStart content ::: headStart
<!-- 上面的语法将会被转化为下面的`HTML`结构 -->
<div class="head-layout">
  content
  <div></div>
</div>

参与贡献

贡献之前请先阅读贡献指南

赞助

如果你觉得这个项目对你有帮助，并且情况允许的话，可以给我一点点支持，总之非常感谢支持～

WeChat

Alipay

License

MIT © Coderlei