Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/kurone-kito/jsonresume-theme-japanese-cv-style-docx

📄 Generate a Word docx file of Japanese-style resume from JSON Resume; since 2019.9
https://github.com/kurone-kito/jsonresume-theme-japanese-cv-style-docx

curriculum-vitae docx docx-generator json-resume jsonresume-theme library npm-package

Last synced: 2 months ago
JSON representation

📄 Generate a Word docx file of Japanese-style resume from JSON Resume; since 2019.9

Host: GitHub
URL: https://github.com/kurone-kito/jsonresume-theme-japanese-cv-style-docx
Owner: kurone-kito
License: mit
Created: 2019-09-26T08:09:44.000Z (over 5 years ago)
Default Branch: master
Last Pushed: 2023-07-18T20:15:31.000Z (over 1 year ago)
Last Synced: 2024-10-17T01:37:33.456Z (3 months ago)
Topics: curriculum-vitae, docx, docx-generator, json-resume, jsonresume-theme, library, npm-package
Language: TypeScript
Homepage: https://kurone-kito.github.io/jsonresume-theme-japanese-cv-style-docx/
Size: 2.6 MB
Stars: 4
Watchers: 2
Forks: 0
Open Issues: 16
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.ja.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.ja.md

Awesome Lists containing this project

README

        # “@kurone-kito/jsonresume-theme-japanese-cv-style-docx”

[![npm version](https://badge.fury.io/js/%40kurone-kito%2Fjsonresume-theme-japanese-cv-style-docx.svg)](https://badge.fury.io/js/%40kurone-kito%2Fjsonresume-theme-japanese-cv-style-docx)

[![Coverage Status](https://coveralls.io/repos/github/kurone-kito/jsonresume-theme-japanese-cv-style-docx/badge.svg?branch=master)](https://coveralls.io/github/kurone-kito/jsonresume-theme-japanese-cv-style-docx?branch=master)

JSON Resume から、日本のお堅い系企業ウケしそうな職務経歴書の Word DOCX

ファイルを生成する NPM パッケージです。既存のテーマは揃いも揃ってモダンで、

かつ Word DOCX を出力できるテーマが見当たりませんでしたので、制作しました。

An NPM package that generates a Word DOCX file of Japanese-style resume

from JSON Resume. The existing themes are all modern and stylish. And then

cannot found that can output Word DOCX.

## Requires

### Strongly recommended

- Node.js >= v16 (On ARM64 e.g. Apple M1)

- Node.js >= v14 (On x86-64)

### or

- Node.js >= v12, and [a latest `full-icu` package](https://github.com/unicode-org/full-icu-npm) (On x86-64)

## Usage

```sh

npm install --save @kurone-kito/jsonresume-theme-japanese-cv-style-docx

```

```JavaScript

import fs from 'fs';

import render from '@kurone-kito/jsonresume-theme-japanese-cv-style-docx';

// // ⬆️ or ⬇️

// const { render } = require('@kurone-kito/jsonresume-theme-japanese-cv-style-docx');

const resume = require('./resume.json');

const filename = 'resume.docx';

render(resume).then(buffer => {

  fs.writeFileSync(filename, buffer);

  console.log(`writted: ${filename}`);

});

```

## API

### render()

```TypeScript

render(resume: EnhancedResume): Promise

```

#### Params

- resume: A JSON Resume object. (See following: [EnhancedResume](#enhancedresume))

#### Returns

Body of the Word DOCX file.

## Types

### EnhancedResume

Enhanced definition of the JSON Resume.

```JSON

{

  "projects": [

    {

      ...

      "env": {

        "os": ["Windows XP", "AIX"],

        "language": ["PL/I", "COBOL"],

        "platforms": ["Excel 2000"]

      }

    }

  ],

  "skills": [

    {

      ...

      "tags": "language"

    },

    {

      ...

      "tags": ["tools", "foobar"]

    }

  ]

}

```

## License

MIT