json-theme-even-fork/README.md

2.6 KiB

jsonresume-theme-even

npm package version Build status Deploy status Code coverage Dependencies status

A flat JSON Resume theme, compatible with the latest resume schema. Inspired by jsonresume-theme-flat.

  • 💄 Markdown support
  • 📐 CSS grid layout
  • 🌗 Light and dark modes
  • 🎨 Customizable colors
  • 🧩 Standalone CLI
  • 📦 ESM and CommonJS builds

View demo →

Installation

npm install jsonresume-theme-even

Usage

With resume-cli

resume-cli comes with Even and uses it by default, so you don't even (pun intended) need to install the theme yourself:

npm install resume-cli
npx resume export resume.html

With Resumed

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:

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:

npx jsonresume-theme-even < resume.json > resume.html

Options

Colors

You can override theme colors via the .meta.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.

Here's an example using the default theme colors:

{
  "meta": {
    "colors": {
      "background": ["#ffffff", "#191e23"],
      "dimmed": ["#f3f4f5", "#23282d"],
      "primary": ["#191e23", "#fbfbfc"],
      "secondary": ["#6c7781", "#ccd0d4"],
      "accent": ["#0073aa", "#00a0d2"]
    }
  }
}