<commit_before># EasyResume

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

欢迎各位fork和star!

------------
## Demo

[查看demo](http://jaskey.github.io/easyresume "例子")

## 在线编辑器

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

链接：[在线编辑器(Beta)](http://jaskey.github.io/easyresume/edit.html "在线编辑")

--------------
## 快速开始
使用`EasyResume`生成自己的在线简历只需要以下几步

1. fork本项目项目
2. 为fork后的项目[开启Github Page功能](https://guides.github.com/features/pages/ "怎样开启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`即可。

## 在线访问： 

更新仓库后，直接访问仓库的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](http://localhost:8000)下查看`index.html`

-----------------------------------------------------------

# 开发者文档

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

建议初次使用者，使用[在线编辑器(Beta)](http://jaskey.github.io/easyresume/edit.html "在线编辑")在线编辑简单的模版后，下载至本地再手动调整。

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

### resume.json键值说明

配置为一个JSON对象，里面支持的key有如下：
<commit_msg>modify README<commit_after># EasyResume

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

欢迎各位fork和star!

------------
## Demo

[查看demo](https://jaskey.github.io/easyresume "例子")

## 在线编辑器

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

链接：[在线编辑器(Beta)](https://jaskey.github.io/easyresume/edit.html "在线编辑")

--------------
## 快速开始
使用`EasyResume`生成自己的在线简历只需要以下几步

1. fork本项目项目
2. 为fork后的项目[开启Github Page功能](https://guides.github.com/features/pages/ "怎样开启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`即可。

## 在线访问： 

更新仓库后，直接访问仓库的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](http://localhost:8000)下查看`index.html`

-----------------------------------------------------------

# 开发者文档

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

建议初次使用者，使用[在线编辑器(Beta)](https://jaskey.github.io/easyresume/edit.html "在线编辑")在线编辑简单的模版后，下载至本地再手动调整。

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

### resume.json键值说明

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

{'fraction_non_alphanumeric': 0.18450946643717728, 'fraction_numerical': 0.013080895008605853, 'mean_word_length': 4.116197183098592, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 9, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '7671350', 'n_tokens_mistral': 1658, 'n_tokens_neox': 1891, 'n_words': 129}