Skip to content

Quickly generate online resume using JSON hosted on github page; 基于github page快速生成在线简历,程序员简历的正确打开方式!

License

Notifications You must be signed in to change notification settings

Jaskey/easyresume

Repository files navigation

EasyResume

EasyResume简单的使用一个json文件,配置属于你的简历的内容,只需要快捷的几步,便能生成一个样式美观整齐的在线简历。(支持移动端显示)

欢迎各位fork和star!


Demo

查看demo

在线编辑器

建议使用在线编辑编辑后再下载到本地手动调整resume.json文件。

链接:在线编辑器(Beta)


快速开始

使用EasyResume生成自己的在线简历只需要以下几步

  1. fork本项目项目
  2. 为fork后的项目(建议用master分支开启)开启Github Page功能
  3. 克隆fork后在个人名下的项目:git clone https://github.com/YourGithubName/easyresume.git
  4. 按照自身的经历,修改项目下的resume.json文件。
  5. commit代码并push到仓库

推仓库命令示意:

git add resume.json
git commit -m "resume init"
git push origin 

以后更新简历,只需要更新resume.json即可。

注:更新前,建议合并本源仓库的新commit

在线访问:

更新仓库后,直接访问仓库的github page即可访问自己的在线简历:https://yourgithubName.github.io/easyresume

本地预览

在推仓库前若想本地预览,需要一个HTTP服务器,在HTTP服务下查看index.html。

若使用了python,在项目路径下使用:

##python2
python -m SimpleHTTPServer

##python3
python -m http.server 8000 

启动一个HTTP服务,然后在http://localhost:8000下查看index.html


开发者文档

整个简历仅需要读取resume.json文件,通过修改resume.json文件即可更新简历内容。本文档详细介绍resume.json中所有的结构及意义。

初次使用者,建议使用在线编辑器(Beta)在线编辑简单的模版后,下载至本地再手动调整。

注:resume.json文件必须严格按照JSON格式,请务必检查好格式,否则简历初始化会失败,建议上传前先使用工具检查好文件格式。

resume.json键值说明

配置为一个JSON对象,里面支持的key有如下:

key 说明 类型 默认
name 姓名 字符串 null
birth 生日 字符串 null
tel 电话 字符串 null
email 邮箱 字符串 null
blog 博客地址 字符串 null
avatar 头像地址 字符串 "/image/avatar.jpg"
pages 个人主页链接 数组 []
summaries 个人概况 字符串数组 []
workExperiences 工作经历 数组 []
projectExperiences 项目 数组 []
sections 自定义经历/段落 数组 []
educations 教育经历 数组 []

其中edit_template.json是一个模版例子,可以按照这个模版填入类容。json详细配置及说明见后续章节。

头像

key: avatar

头像默认使用项目路径下**/image/avatar.jpg** 。

若需要更改,可以自己放置一个图片到对应路径下,并在resume.json上修改路径即可。

工作经历

key: workExperiences

配置是一个对象数组,对象配置如下:

key 说明 类型 是否可空
company 公司名 字符串 NO
post 所任职位 字符串 NO
startDate 就职开始日期 字符串 NO
endDate 就职结束日期 字符串 NO
summary 概览 字符串 YES
details 经历详情 数组 YES

项目经历

key: projectExperiences

配置是一个对象数组,对象配置如下:

key 说明 类型 是否可空
projectName 项目名称 字符串 NO
role 担任角色 字符串 YES
startDate 项目开始日期 字符串 NO
endDate 项目结束日期 字符串 NO
summary 概览 字符串 YES
details 项目详情 字符串数组 YES

教育经历

key: educations

配置是一个对象数组,对象配置如下:

key 说明 类型 是否可空
university 学校名 字符串 NO
studyType 学历 字符串 NO
major 专业 字符串 NO
startDate 教育经历开始日期 字符串 NO
endDate 教育经历结束日期 字符串 NO
gpa 绩点 字符串 YES
scholarships 奖学金 字符串数组 YES
experiences 校园经历详情 字符串数组 YES

个人主页配置

key: pages

配置例子:

   		"pages":[
			{"zhihu":"http://www.zhihu.com/people/linjunjie1103"},
			{"stackoverflow":"http://stackoverflow.com/users/2087628/jaskey"},
			{"github":"https://github.com/Jaskey"},
			{"linkedin":"http://www.linkedin.com/in/jaskeylam/zh-cn?locale=zh_CN&trk=profile_view_lang_sel_click"},
			{"douban":"http://www.douban.com/people/linjunjie1103/"}
		]

对象中每个key代表一个主页类型,value是则是对应的主页链接。

key将用于渲染对应的图标,目前支持的图标有:

key 主页
stackoverflow StackOverflow
zhihu 知乎
github Github
linkedin 领英
douban 豆瓣
segmentfault SegmentFault
wechat 微信
lofter Lofter
weibo 新浪微博

自定义段落

配置示例:

    "sections": [
    	{
        	"title": "学生干部经历",
        	"fragments":[
            	{
                	"name":"大学生职业规划园",
                	"comment":"副主席(分管人力资源部、公关部)",
                	"startDate":"2013/09",
                	"endDate":"2014/06",
                	"summary":"",
                	"details":[
                    "多次负责组织招新、大型比赛、内部培训等筹划,作为我园公关代表联系兄弟组织、与商家洽谈赞助;",
                    "汇编适用全园制度,修改“部门评优制度”、“绩效考核制度”、“优秀干部评选条例”并沿用至今;"
                	]        
            	},
           		 {
                	"name":"信息学院",
                	"comment":"2013级新生助理班主任",
                	"startDate":"2013/09",
                	"endDate":"2014/06",
                	"summary":"2013届信息学院软件1班班主任",
                	"details":[
                    	"引导新生迅速适应大学生活,为本班28名新生提供学习、生活、心理等咨询和帮助;",
                    	"班级获得学院先进班集体、团日活动优秀奖,近半数人成为学生干部,近10人获得校三等以上奖学金。" 
                	]        
            	}
        	]
    	},

    	{
        	"title": "英语能力",
        	"points": [
            	"英语六级",
				"能无障碍阅读英文技术文档、论文"
        	]
    	}
	]

说明:

sections数组的每个对象表示一个自定义模块,其中title是要显示的标题。

后面跟随一个经历的对象数组。自定义段落支持两种格式,一种是带开始时间、结束时间、副标题的fragments;另一种是只列详情的points(适合于列技能、奖项等)

配置说明:

  • fragments :配置项和项目经历的配置一致。具体请参看配置示例。
  • points : 配置项中接受一个字符串数组。具体请参看配置示例

Github Page 404

若曾经页面可以访问,后续发现404,请检查github page配置的分支、连接正确,若均正常可参考以下解决方案:

https://stackoverflow.com/questions/11577147/how-to-fix-http-404-on-github-pages

打赏一块几毛

如果EasyResume帮助到你找工作了,打赏几毛呗。支付宝帐号:120681430@qq.com

License

Available under the MIT license.

About

Quickly generate online resume using JSON hosted on github page; 基于github page快速生成在线简历,程序员简历的正确打开方式!

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published