Skip to content

A modern theme for JSON Resume which is self-contained. The content of the resume will work offline and can be hosted without depending on or making requests to third-party servers.

License

Notifications You must be signed in to change notification settings

jsonresume/jsonresume-theme-class

Repository files navigation

Class Theme for JSON Resume

matrix npm package

A modern theme for JSON Resume which is self-contained. The content of the résumé will work offline and can be hosted without depending on or making requests to third-party servers.

Usage

# Install resume-cli via npm, yarn, pnpm, or whatever package manager you want
npm install --global resume-cli

# Install @jsonresume/jsonresume-theme-class in the directory resume.json is in
npm install @jsonresume/jsonresume-theme-class

# Export as an HTML page, ready to be served by any web server
resume export --theme @jsonresume/jsonresume-theme-class index.html

# Export a PDF document, it's recommended to use your name as the file name
resume export --theme @jsonresume/jsonresume-theme-class your-name.pdf

Accessibility

It's recommended to declare the meta.language property in your JSON Resume for accessibility. This is the BCP47 tag for the language your résumé is written in. For example, en for English.

For Servers

Heads-up! ⚠️ This project doesn't sanitize the input/output. Typical usage is to run this locally with your own JSON Resume, so a trustworthy environment with trustworthy input. If this project will be deployed in a server environment, you must use a library like DOMPurify to sanitize the output.

Features

JSON Resume 1.0.0

This supports the JSON Resume 1.0.0 spec and is backward compatible with earlier versions.

Application Tracking System (ATS) Friendly

Many companies and recruiters use ATS systems that parse CVs and extract the information into a standard format. We review some of these tools and adhere to standard practices while building the theme.

Markdown

You can use inline Markdown in the following properties to make text bold, italic, or link them to external pages:

  • summary
  • highlights

Localized

Using the same meta.language property referred to in Accessibility, you can configure the language of the template too. For example, if you write your résumé in Dutch, the output will have Dutch headings.

Open Graph Protocol

Populates the head of the HTML document with Open Graph tags. This enables social media platforms and instant messengers to create embeds when your résumé is shared.

Dark Mode

Includes a dark mode, and uses the prefers-color-scheme CSS property to provide a positive user-experience.

Optimized

This theme makes no external connections, doesn't embed scripts, and is lightweight by design. Both HTML and PDF exports are minimal.

Preview

The Class theme for JSON Resume rendered with mock data. Features a plain blue bar at the top containing the candidates name and role, then a plain white background with contact information, work experience, volunteer information, etc. The Class theme for JSON Resume rendered with mock data when dark mode is detected. Features a dark gray bar at the top containing the candidates name and role, then a slightly lighter gray background with contact information, work experience, volunteer information, etc.

About

A modern theme for JSON Resume which is self-contained. The content of the resume will work offline and can be hosted without depending on or making requests to third-party servers.

Topics

Resources

License

Stars

Watchers

Forks

Contributors 6