# render-resume

> [npm package render-resume](https://www.npmjs.com/package/render-resume)

Latest version **0.9.11** (published 2018-11-06) · ISC license · 0 weekly downloads

## Install

```sh
npm install render-resume
pnpm add render-resume
yarn add render-resume
bun add render-resume
```

Provides the commands `render-resume`, `generate-resume-source`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.9.11 |
| Published | 2018-11-06 |
| First published | 2018-11-06 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 8 |
| Unpacked size | 666.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 9 |
| Maintainers | kennyhyun |

## Links

- npm: https://www.npmjs.com/package/render-resume
- Repository: https://github.com/kennyhyun/word-resume
- Homepage: https://github.com/kennyhyun/word-resume#readme
- Issues: https://github.com/kennyhyun/word-resume/issues
- npm.io page: https://npm.io/package/render-resume

## Dependencies (8)

- [docx](https://npm.io/package/docx.md) ^4.3.0
- [chance](https://npm.io/package/chance.md) ^1.0.16
- [lodash](https://npm.io/package/lodash.md) ^4.17.11
- [moment](https://npm.io/package/moment.md) ^2.22.2
- [js-yaml](https://npm.io/package/js-yaml.md) ^3.12.0
- [babel-core](https://npm.io/package/babel-core.md) ^7.0.0-bridge.0
- [@babel/polyfill](https://npm.io/package/@babel/polyfill.md) ^7.0.0
- [underscore.string](https://npm.io/package/underscore.string.md) ^3.3.5

## Recent versions

- 0.9.11 (latest) — 2018-11-06

## README

# Word resume generator

[npm package render-resume](https://www.npmjs.com/package/render-resume)

Generate docx resume from yaml data using [docx](https://github.com/dolanmiu/docx)

* Avoid hassles like updating dates and focus on the contents.
* Generate Uptodate resume instantly
* Pdf conversion is also handy when you use libre office cli
* manage the source file with your everday editor
* multiple revison (wip)

** pretty much experimental yet

## Usage

### npm (recommended)

in a blank directory

```
$ git init
$ npm init --yes
$ npm install -S render-resume
$ npx generate-resume-source resume.yml
$ git add . && git commit -m "init"
```

edit the yaml file for your resume and render

```
$ npx render-resume resume.yml
```

repeat editing and render until you want and you can commit and keep your own yaml in the local repo

### git clone

After cloning this repo,
```
$ npm i
$ npm run output -- sample.yml
```

### Programmatic

npm install

```
$ npm i render-resume -S
```

in js

```
import docx from 'docx';
import fs from 'fs';
import render, { seeder } from 'render-resume';

const doc = render(seeder('some-random-seed'));
const packer = new docx.Packer();
const buffer = await packer.toBuffer(doc);
fs.writeFile('filename.docx', buffer);
```

## Yaml source format

### header

provides meta data.

#### paragraphs

`paragraphs.$.source` has data key.
`paragraphs.$.title` has the title of the paragraph.

paragraphs in the data are rendered by this order.

#### focusOn

Any data field name can have default key and override by the contents of the default.
If focusOn has been provided, find focusOn key first, and use it if exists.


### data

please refer to [sample.yml](sample.yml)


## Todos

- [x] add test script
- [x] convert to npm library
- [x] publish npm v0.9.2
- [ ] add using custom style.xml
- [ ] add template to change styles

## Screen shot

![sample](https://user-images.githubusercontent.com/5399854/47976379-42b4d200-e106-11e8-800c-4f41ddebb14b.png)

---
_Source: https://npm.io/package/render-resume · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._