README.zh-CN.md

所见即所得的在线简历 | Stackblitz Playground | English

项目介绍

初衷

让简历可以随时随地预览，用程序员最熟悉的Markdown语法编写，并且不收费！

支持功能

• 支持暗黑模式
• 支持嵌入 HTML
• 支持打印 PDF
• 支持在线预览
• 支持自定义模板
• 支持多模板组合使用
• 支持样式覆盖
• 更多的个性化模板

使用方式

create-resumejs

快速创建简历项目，支持在 Vercel 中部署

1. 创建

pnpm create resumejs

2. 选择模板

3. 编写 README.md

4. 完成你的简历！

@resumejs/components

以组件方式引入到自己项目

下载

pnpm add @resumejs/components

使用

import { Resume } from '@resumejs/components'

export default function App() {
  const resume = `
    #名字
    ##个人信息
    ##工作信息
  `
  return <Resume>{resume}</Resume>
}

使用示例

• vite-ant-design-pro

@resumejs/resume

• cli 支持，使用方式和 vite 一样
• 默认使用运行目录下的 README.md 做为你的简历 markdown
• 支持 vite.config.ts 配置文件

可以直接使用 create-resumejs 创建项目

Install

pnpm add @resumejs/resume

需要安装依赖 react 和 react-dom

pnpm add react react-dom

dev 开发

resume dev

build 打包

resume build

preview 预览

resume preview

自定义模板

resume dev --template @resumejs/template-nova
resume build --template @resumejs/template-nova

参考示例

Templates

• @resumejs/template-default 默认模板
• @resumejs/template-nova

简历默认模板

如何自定义模板？

自定义的写简历的 markdown 语法

1. 一级标题下的内容包括一级标题为简历头部的信息 可自定义header组件

   • 一级标题为名字 可自定义header-name组件
   • 图片作为头像 可自定义header-avatar组件
   • 包裹所有列表项 可自定义header-content组件
   • 每个列表为行 可自定义header-row组件
   • 列表的项为列 可自定义header-col组件

2. 三级标题下方的第一段内容

   • 表格将更改为三级标题的描述信息，可自定义card, card-item, card-item-label, card-item-value组件
   • 标题下或 Table 下第一行文本将会更改为描述内容 可自定义description组件

3. FrontMatter (暗黑模式，Github, 打印按钮)

   • 可自定义 toolbox 组件

示例

• 默认模板

相关文章

一款更加完善，且易于拓展的用 Markdown 编写简历的开源简历项目

部署

这非常简单，只需点击上面的按钮即可部署到 Vercel。您还可以部署到支持 Vite 的其他平台。

Others

This project is tested with BrowserStack.

MIT LICENSE