https://github.com/philippbaschke/cv

A React PDF and YAML CV generator
https://github.com/philippbaschke/cv

Last synced: 4 days ago
JSON representation

A React PDF and YAML CV generator

• Host: GitHub
• URL: https://github.com/philippbaschke/cv
• Owner: PhilippBaschke
• License: gpl-3.0
• Created: 2022-03-04T11:21:44.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2023-07-08T08:23:58.000Z (over 1 year ago)
• Last Synced: 2024-12-08T00:38:27.612Z (26 days ago)
• Language: TypeScript
• Size: 61.7 MB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# @philippbaschke/cv

A React PDF and YAML CV generator

[![npm version](https://img.shields.io/npm/v/@philippbaschke/cv?style=flat-square)](https://www.npmjs.com/package/@philippbaschke/cv)

[![XO code style](https://img.shields.io/badge/code_style-XO-5ed9c7.svg?style=flat-square)](https://github.com/xojs/xo)

[![License](https://img.shields.io/github/license/PhilippBaschke/cv?style=flat-square)](LICENSE)

## Table of Contents

- [Usage](#usage)

- [CLI Commands](#cli-commands)

- [Example](#example)

## Usage

```sh

# Create the CV data project

npx @philippbaschke/cv init

# Go to the CV data project folder

cd cv-data

# Create the CV PDF

npx @philippbaschke/cv create

# Open the CV PDF with the default application

open cv.pdf

```

## CLI Commands

The commands can be run with `npx @philippbaschke/cv `.

### init

The `init` command initializes a git project for the CV data.

#### Usage

```sh

npx @philippbaschke/cv init [path]

```

#### Arguments

| Name   | Default   | Description                                            |

| ------ | --------- | ------------------------------------------------------ |

| `path` | `cv-data` | A path where the CV data project should be initialized |

### create

The `create` command creates the PDF.

#### Usage

```sh

npx @philippbaschke/cv create [options] [output-file]

```

#### Arguments

| Name          | Default  | Description                          |

| ------------- | -------- | ------------------------------------ |

| `output-file` | `cv.pdf` | A path where the PDF should be saved |

#### Options

| Name                        | Default         | Description                 |

| --------------------------- | --------------- | --------------------------- |

| `-d, --data-project ` | `process.cwd()` | A path to a CV data project |

## Example

[![Example CV](docs/cv.png)](docs/cv.pdf)