json-theme-even-fork/README.md

# jsonresume-theme-even

[![npm package version](https://img.shields.io/npm/v/jsonresume-theme-even.svg)](https://www.npmjs.com/package/jsonresume-theme-even)
[![Build status](https://img.shields.io/github/workflow/status/rbardini/jsonresume-theme-even/Main)](https://github.com/rbardini/jsonresume-theme-even/actions)
[![Deploy status](https://img.shields.io/netlify/7c0cb4f0-e270-4085-8f75-a8850cf45b2a?label=deploy)](https://app.netlify.com/sites/jsonresume-theme-even/deploys)
[![Code coverage](https://img.shields.io/codecov/c/github/rbardini/jsonresume-theme-even.svg)](https://codecov.io/gh/rbardini/jsonresume-theme-even)
[![Dependencies status](https://img.shields.io/librariesio/release/npm/jsonresume-theme-even)](https://libraries.io/npm/jsonresume-theme-even)

A flat [JSON Resume](https://jsonresume.org/) theme, compatible with the latest [resume schema](https://github.com/jsonresume/resume-schema).
Inspired by [jsonresume-theme-flat](https://github.com/erming/jsonresume-theme-flat).

- 💄 Markdown support
- 📐 CSS grid layout
- 🌗 Light and dark modes
- 🧩 Standalone CLI
- 📦 ESM and CommonJS builds

[View demo →](https://jsonresume-theme-even.rbrd.in)

## Installation

```console
npm install jsonresume-theme-even
```

## Usage

### With resume-cli

[resume-cli](https://github.com/jsonresume/resume-cli) comes with _Even_ and uses it by default, so you don't even (pun intended) need to install the theme yourself:

```console
npm install resume-cli
npx resume export resume.html
```

### With Resumed

[Resumed](https://github.com/rbardini/resumed) requires you to install the theme, since it does not come with any by default. It will then automatically load and use _Even_ when rendering a resume:

```console
npm install resumed jsonresume-theme-even
npx resumed render
```

See [example](https://github.com/rbardini/resume.rbardini.com).

### Standalone usage

_Even_ comes with a barebones CLI that reads resumes from `stdin` and outputs HTML to `stdout`. This allows usage without any resume builder tools:

```console
cat resume.json | npx jsonresume-theme-even > resume.html
```

See [example](https://github.com/beacampbell/resume).
Add formatting - Add format script - Format all files - Add .prettierignore - Add .prettierrc.json - Add Prettier dev dependency 2020-07-05 14:19:26 +02:00			`# jsonresume-theme-even`
0.1.0 2018-09-23 20:28:05 +02:00
			`[![npm package version](https://img.shields.io/npm/v/jsonresume-theme-even.svg)](https://www.npmjs.com/package/jsonresume-theme-even)`
Update README - Add build, coverage and devDependencies badges - Remove license section 2020-07-05 17:26:03 +02:00			`[![Build status](https://img.shields.io/github/workflow/status/rbardini/jsonresume-theme-even/Main)](https://github.com/rbardini/jsonresume-theme-even/actions)`
docs(readme): add features and usage instructions 2021-03-07 14:17:41 +01:00			`[![Deploy status](https://img.shields.io/netlify/7c0cb4f0-e270-4085-8f75-a8850cf45b2a?label=deploy)](https://app.netlify.com/sites/jsonresume-theme-even/deploys)`
Update README - Add build, coverage and devDependencies badges - Remove license section 2020-07-05 17:26:03 +02:00			`[![Code coverage](https://img.shields.io/codecov/c/github/rbardini/jsonresume-theme-even.svg)](https://codecov.io/gh/rbardini/jsonresume-theme-even)`
docs(readme): readd dependencies badges 2021-12-27 19:22:33 +01:00			`[![Dependencies status](https://img.shields.io/librariesio/release/npm/jsonresume-theme-even)](https://libraries.io/npm/jsonresume-theme-even)`
0.1.0 2018-09-23 20:28:05 +02:00
docs(readme): update description and demo badge 2021-03-05 10:45:57 +01:00			`A flat [JSON Resume](https://jsonresume.org/) theme, compatible with the latest [resume schema](https://github.com/jsonresume/resume-schema).`
			`Inspired by [jsonresume-theme-flat](https://github.com/erming/jsonresume-theme-flat).`
0.1.0 2018-09-23 20:28:05 +02:00
docs(readme): add features and usage instructions 2021-03-07 14:17:41 +01:00			`- 💄 Markdown support`
			`- 📐 CSS grid layout`
feat(dark): add dark mode support 2021-03-07 14:50:42 +01:00			`- 🌗 Light and dark modes`
docs(readme): add features and usage instructions 2021-03-07 14:17:41 +01:00			`- 🧩 Standalone CLI`
feat(esm): migrate to ESM - Build with microbundle - Add build step to GitHub Actions workflow 2021-11-05 18:39:36 +01:00			`- 📦 ESM and CommonJS builds`
docs(readme): add features and usage instructions 2021-03-07 14:17:41 +01:00
docs(readme): update demo URL 2022-03-30 15:51:20 +02:00			`[View demo →](https://jsonresume-theme-even.rbrd.in)`
docs(readme): add features and usage instructions 2021-03-07 14:17:41 +01:00
0.1.0 2018-09-23 20:28:05 +02:00			`## Installation`

Update README - Add build, coverage and devDependencies badges - Remove license section 2020-07-05 17:26:03 +02:00			```console
			`npm install jsonresume-theme-even`
			```
docs(readme): add features and usage instructions 2021-03-07 14:17:41 +01:00
			`## Usage`

			`### With resume-cli`

			`[resume-cli](https://github.com/jsonresume/resume-cli) comes with _Even_ and uses it by default, so you don't even (pun intended) need to install the theme yourself:`

			```console
			`npm install resume-cli`
			`npx resume export resume.html`
			```

			`### With Resumed`

			`[Resumed](https://github.com/rbardini/resumed) requires you to install the theme, since it does not come with any by default. It will then automatically load and use _Even_ when rendering a resume:`

			```console
			`npm install resumed jsonresume-theme-even`
			`npx resumed render`
			```

docs(readme): add Resumed and standalone examples 2021-11-06 14:45:45 +01:00			`See [example](https://github.com/rbardini/resume.rbardini.com).`

docs(readme): add features and usage instructions 2021-03-07 14:17:41 +01:00			`### Standalone usage`

			_Even_ comes with a barebones CLI that reads resumes from `stdin` and outputs HTML to `stdout`. This allows usage without any resume builder tools:

			```console
			`cat resume.json \| npx jsonresume-theme-even > resume.html`
			```
docs(readme): add Resumed and standalone examples 2021-11-06 14:45:45 +01:00
			`See [example](https://github.com/beacampbell/resume).`