0.0.8 • Published 2 years ago

jsonresume-theme-gnap v0.0.8

Weekly downloads
-
License
MIT
Repository
github
Last release
2 years ago

jsonresume-theme-gnap

JSON resume theme built with materialize css. It supports JSON resume schema version 1.0.0 and provides support for contact form and custom headers by (ab)using the meta section. You can see it in action here.

npm.io npm.io npm.io

Contact form

The theme can render a contact form by adding some code to the meta section as in the example below. If resume.meta.contactForm isn't present the theme defaults to generating a mailto link to resume.basics.email (if present).

{
  "meta": {
    "contactForm": {
      "action": "https://some.url",   // Where to submit the form.
      "method": "POST",               // HTTP method to use when submitting the form. Default: "POST"
      "header": "Contact Smurf",      // Default: "Contact"
      "fields": [                     // Array used to configure the form's input fields
        { 
          "name": "from",             // name is used for the field's id and name attributes.
          "label": "E-mail",          // label is used for the text in the field's <label> element.
          "type": "email",            // Default "text". Used for for the type attribute of <input>.
          "value": ""                 // Default value for the field. Optional
        },
        {
          "name": "body",
          "label": "Message",
          "multiline": true           // if multiline is true the field will be a <textarea>
        }
      ],
      "buttons": {
        "submit": {                   // At the time of writing only one button is supported - submit
          "text": "Smurf"             // Default: "Send"
        }
      },
      "messages": {                   // Messages to be displayed after submitting the form
        "success": "Message smurfed", // Default: "Message sent"
        "failure": "GNAP!"            // Default: "Failed to send message"
      }
    }
  }
}

Customized section headers

Section headers can be configured in the meta section:

{
  "meta": {
    "headers": {                        // Named after the JSON resume schema sections.
      "basics": "Profile",              // Default: "Profile"
      "skills": "Skills",               // Default: "Skills"
      "languages": "Languages",         // Default: "Languages"
      "projects": "Projects",           // Default: "Projects"
      "work": "Work",                   // Default: "Work"
      "education": "Education",         // Default: "Education"
      "references": "References",       // Default: "References"
      "interests": "Interests",         // Default: "Interests"  
      "certificates": "Certificates",   // Default: "Certificates"
      "awards": "Awards",               // Default: "Awards"
      "volunteer": "Volunteer",         // Default: "Volunteer"
      "publications": "Publications"    // Default: "Publications"
    }
  }
}

Having issues?

This theme is provided with no support whatsoever as per the conditions in the license agreement. If you encounter any issues feel free to post them here but I won't make any promises about having the time to fix them :wink:.