Go to file
Rafael Bardini dec4e36093 build(types): provide type hints via JSDoc 2023-09-28 02:50:43 +02:00
.github/workflows build(types): provide type hints via JSDoc 2023-09-28 02:50:43 +02:00
.husky feat(deps): migrate to Vite and Vitest 2023-01-31 02:41:43 +01:00
bin feat(deps): migrate to Vite and Vitest 2023-01-31 02:41:43 +01:00
components build(types): provide type hints via JSDoc 2023-09-28 02:50:43 +02:00
test feat(color)!: move colors to `.meta.themeOptions` 2023-09-17 00:54:31 +02:00
utils build(types): provide type hints via JSDoc 2023-09-28 02:50:43 +02:00
.eslintrc.json docs(editor): replace static demo with editor 2023-09-15 03:42:17 +02:00
.gitignore build(types): provide type hints via JSDoc 2023-09-28 02:50:43 +02:00
.lintstagedrc.json Fix lint-staged glob pattern 2020-07-08 19:38:09 +02:00
.nvmrc build(node): use latest Node.js LTS version 2021-03-05 10:34:26 +01:00
.prettierrc.json docs(editor): replace static demo with editor 2023-09-15 03:42:17 +02:00
LICENSE 0.1.0 2018-10-06 14:50:02 +02:00
README.md build(types): provide type hints via JSDoc 2023-09-28 02:50:43 +02:00
editor.css docs(editor): replace static demo with editor 2023-09-15 03:42:17 +02:00
editor.js docs(editor): replace static demo with editor 2023-09-15 03:42:17 +02:00
index.html docs(editor): replace static demo with editor 2023-09-15 03:42:17 +02:00
index.js build(types): provide type hints via JSDoc 2023-09-28 02:50:43 +02:00
netlify.toml docs(editor): replace static demo with editor 2023-09-15 03:42:17 +02:00
package-lock.json build(types): provide type hints via JSDoc 2023-09-28 02:50:43 +02:00
package.json build(types): provide type hints via JSDoc 2023-09-28 02:50:43 +02:00
resume.js build(types): provide type hints via JSDoc 2023-09-28 02:50:43 +02:00
style.css feat(color): support custom colors 2023-09-04 02:29:45 +02:00
tsconfig.json build(types): provide type hints via JSDoc 2023-09-28 02:50:43 +02:00
vite.config.js build(types): provide type hints via JSDoc 2023-09-28 02:50:43 +02:00

README.md

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
  • 🤖 TypeScript typings

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.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.

Here's an example using the default theme colors:

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