Skip to content

romancow/jsonresume-theme-swilson

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

88 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Sean Wilson's custom JSON Resume theme

This is my custom JSON Resume theme, created for use with my own résumé. But you can use it too, if you like! Take a look at my résumé to see it in action. It uses the Pug templating engine to create the markup and Stylus for styling.

How To Use

Add this theme package as a a dependency to your project containing your résumé JSON. Currently the package is not on npm, so you will have to use the GitHub npm package manager. Info on doing this can be found here. Basically it amounts to the following steps:

  1. Create a GitHub access token with (at least) a packages:read scope.

  2. Add a scope mapping and the access token for the GitHub npm package manager by adding a .npmrc file with lines:

	@romancow:registry=https://npm.pkg.github.com/
	//npm.pkg.github.com/:_authToken=YOUR_AUTH_TOKEN_HERE
  1. Install the package:

    npm install @romancow/jsonresume-theme-swilson

You should then be able to use a package like resumed or resume-cli to render your résumé using this theme, specifiying the "swilson" theme if necessary (--theme swilson).

Extra Fields

There are a few extra json fields the swilson theme uses in addtion to the standarad JSON Resume schema ones. These fields are all optional, and your json should still validate with them.

basics.notes (string[])
General notes to show at the top of the résumé beneath the header. Used on my own résumé to show a "Learn more" link.
projects[].icon (string)
The name of a FontAwesome icon to show underneath the project name. This allows you to customize the icon to fit the type of project.
education[].honors (string[])
A list of education related honors you may have received. For example, "Valedictorian" or latin honors.
references[].at (string)
The name of a company or organization (or just generally the significance) of the person providing the reference.
references[].position (string)
The position or role of the person providing the reference.

Markdown

The following fields support Markdown content:

  • basics.summary
  • basics.notes[]
  • awards[].summary
  • certificates[].summary
  • publications[].summary
  • education[].honors[]
  • projects[].description
  • references[].reference
  • work[].highlights[]
  • volunteer[].highlights[]
  • projects[].highlights[]
  • work[].summary
  • volunteer[].summary

Query String Vars

The generated HTML version of the résumé has a few supported query string variables you can pass in the url to customize color and fonts.

Basic Example: https://www.seanwilson.dev/?secondary-font-color=%23CFAE70&accent-bg-color=DimGray

Colors

body-bg-color
The color of the area outside/between the résumé "sections" & header. Default: #ffffff
primary-bg-color
The background color inside résumé "section" boxes (i.e. profile, skills, work experience, etc.). Default: #fbfbfb
primary-font-color
The color of text inside résumé "section" boxes. Default: #333333
secondary-bg-color
The background color of the résumé header. Default: #232323
secondary-font-color
The color of text inside the résumé header and "accent" backgrounds. Default: #fbfbfb
accent-bg-color
An "accent" background color, used for résumé "section" box subheaders (work experience & volunteer) and keywords. Default: #8b95a2
accent-font-color
An "accent" font color, used in places like notes, reference quotes, and subtitles (e.g. education study type, project roles). Default: #777777

Fonts

primary-font
The primary font used in most places in the résumé. Default: 'Roboto', sans-serif
secondary-font
The alternate font used in the header label and section name headers. Default: 'Roboto Slab', serif

If you do use this theme, I'd love to know about it. Drop me a line at hi@seanwilson.dev.