Skip to content
Antoine Boucher

jsonresume-theme-kendall: A JSON document into a resume template

This fork of the Kendall JSON Resume theme turns structured resume data into HTML. The renderer prepares presentation fields before handing the result to a Mustache template and the accompanying screen and print styles.

Library Fork
  • Updated
  • JavaScript · 55.76%
  • MIT
Upstream credited
View source README
Repository languagesJavaScript 55.76%2

Shares calculated from GitHub Linguist bytes.

Language%Bytes
JavaScript55.76%8,126
CSS44.24%6,448

GitHub · README · Language statistics

Overview

Why it exists

Minimalist, print-perfect resume theme supporting schema.org semantic markup and clean layout.

Best fit

Automated resume compilation from structured JSON data.

Getting started

These commands come from the repository documentation. They were not run during this review.

README.md · Install the command line 
sudo npm install -g resume-cli
README.md · Install npm packages 
sudo npm install
README.md · Serve theme 
resume serve --theme .
README.md · Serve theme 
Preview: http://localhost:4000
Press ctrl-c to stop
Tasks declared in manifests

package.json

test
echo "Error: no test specified" && exit 1

Repository references

Excerpts from the repository’s guides, in their original language. Links open the inspected source revision.

Prerequisites and first run

Install the command line

README.md

We’re going to use the official resume-cli to run our development server. Go ahead and install it:
Read the full instructions ↗

Install npm packages

README.md

We need to install the dependencies. cd into the theme folder we just downloaded and run: This will read the local package.json and install the packages listed under dependencies.
Read the full instructions ↗
Configuration and usage

Usage

README.md

To first get started with this JSONResume theme, you’ll need to have the JSONResume CLI installed. If you haven’t already install it with npm install -g resume-cli. If this doesn’t work, try sudo npm install -g resume-cli. After this, you can get your resume.json ready by typing resume init. After hitting enter, your resume will be initialized and you can edit it and fill in the neccessary fields. Check out the official resume-schema repository for more information on filling these fields. When you are finished with your resume, you may test it by yet again opening the command line and typing resume serve –theme kendall to see how it looks with this theme. You can replace the word kendall with other theme names too.
Read the full instructions ↗
Source documentation

1 documents read from 1 candidates.

Features and components 2

Presentation mapping
index.js maps network names to icon classes, formats work dates and derives flags for optional sections. It also chooses an explicit image or a Gravatar URL. This logic adapts data for the template.
Template and styles
resume.template contains the HTML layout, while style.css and print.css separate screen and print appearance. The data transformation and document layout can be inspected independently.

Architecture

The components and their connections remain available as text. The diagram adds an interactive view.

System context Context
  1. Resume JSON
  2. render data mapping
  3. Mustache template
  4. HTML with screen or print CSS

Links verified in the repository.

Mermaid Interactive diagram (loads on open)

System overview of the components and connections verified in the repository.

Static architecture view for jsonresume-theme-kendall
Static preview. The interactive diagram replaces it after Mermaid loads.
flowchart LR
  n0["Resume JSON"]
  n1["render data mapping"]
  n2["Mustache template"]
  n3["HTML with screen or print CSS"]
  n0 --> n1
  n1 --> n2
  n2 --> n3
Text version of the diagram
  • Resume JSON → render data mapping
  • render data mapping → Mustache template
  • Mustache template → HTML with screen or print CSS
Follow one path through the code

Follow a work startDate into the derived month and year fields. The renderer mutates fields on the supplied object, so callers reusing that object should account for the added presentation data.

File structure

The map shows the inspected files and their organization.

Reference

3 / 3 eligible files read (9 in the tree); 0 oversized, 0 failed reads and 0 syntax diagnostics.

What the scan covers

Known dependency/build folders, credential files and binaries are excluded. The scan covers READMEs, recognized manifests and parser-supported source files.

Linguist statistics cover the whole repository and may include other languages.

File map
flowchart TD
  root["jsonresume-theme-kendall"]
  f0["index.js"]
  root --> f0
  f1["README.md"]
  root --> f1
  f2["package.json"]
  root --> f2

Files to read 3

References