json-theme-even-fork/README.md

79 lines
2.7 KiB
Markdown
Raw Normal View History

# jsonresume-theme-even
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)
2023-01-30 02:53:52 +01:00
[![Build status](https://img.shields.io/github/actions/workflow/status/rbardini/jsonresume-theme-even/main.yml)](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)
2018-09-23 20:28:05 +02: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).
2018-09-23 20:28:05 +02:00
- 💄 Markdown support
- 📐 CSS grid layout
2021-03-07 14:50:42 +01:00
- 🌗 Light and dark modes
2023-09-04 02:29:45 +02:00
- 🎨 Customizable colors
- 🧩 Standalone CLI
- 📦 ESM and CommonJS builds
- 🤖 TypeScript typings
2022-03-30 15:51:20 +02:00
[View demo →](https://jsonresume-theme-even.rbrd.in)
2018-09-23 20:28:05 +02:00
## 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
```
### 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
npx jsonresume-theme-even < resume.json > resume.html
```
2023-09-04 02:29:45 +02:00
## Options
### Colors
You can override theme colors via the `.meta.themeOptions.colors` resume field. Each entry defines a tuple of light and (optional) dark color values. If only one array value is defined, it will be used in both light and dark modes.
2023-09-04 02:29:45 +02:00
Here's an example using the default theme colors:
```json
{
"meta": {
"themeOptions": {
"colors": {
"background": ["#ffffff", "#191e23"],
"dimmed": ["#f3f4f5", "#23282d"],
"primary": ["#191e23", "#fbfbfc"],
"secondary": ["#6c7781", "#ccd0d4"],
"accent": ["#0073aa", "#00a0d2"]
}
2023-09-04 02:29:45 +02:00
}
}
}
```