The JSON Resume Format

Below is a sample JSON Resume file, annotated with explanations for each field. Note that:

{
  "version":"An identifier for the schema verion (currently '1'). If there are future updates to the schema, then ResumeFodder can use this field to recognize outdated files and warn you about it.",
  "basics": {
    "name": "Your first and last name",
    "label": "",
    "picture": "",
    "email": "Your email address",
    "phone": "A phone number, with any formatting you like. E.g. (555) 555-5555.",
    "degree": "",
    "website": "Your website URL",
    "summary": "A one-sentence to one-paragraph overview text. Do not include any line-breaks.",
    "highlights": [
        "Bullet-point list items that you would like to include along with (or instead of) a summary paragraph."
    ],
    "location": {
      "address": "Your street address or mailing address",
      "postalCode": "Your postal code (ZIP in the U.S.)",
      "city": "Your city",
      "countryCode": "Your country (e.g. USA)",
      "region": "Your region (state in the U.S.)"
    },
    "profiles": [
      {
        "network": "A social media or other profile that you would like to include (e.g. LinkedIn, Twitter)",
        "username": "Your username on this network",
        "url": "A URL to your user profile page"
      }
    ]
  },
  "work": [
    {
      "company": "Your employer name",
      "position": "Your job title",
      "website": "The URL for the employer's website",
      "startDate": "Your start date, in YYYY-MM-DD format",
      "endDate": "Your end date, in YYY-MM-DD format (leave blank for a current position)",
      "summary": "A one-sentence to one-paragraph summary of this employer or position",
      "highlights": [
        "Bullet-point list items that you would like to include along with (or instead of) a summary paragraph."
      ]
    }
  ],
  "additionalWork": [
    {
      "company": "Job history that you would like to group separately (e.g. old jobs, academic positions, etc)",
      "position": "All fields under the section are the same as for 'work'",
      "website": "",
      "startDate": "",
      "endDate": "",
      "summary": "",
      "highlights": [
        "Templates typically omit highlights for 'additionalWork' positions"
      ]
    }
  ],
  "workLabel": "Overrides the template label for the 'work' section (e.g. 'Recent Experience')",
  "additionalWorkLabel": "Overrides the template label for the 'additionalWork' section (e.g. 'Prior Experience')",
  "education": [
    {
      "institution": "Your school name",
      "area": "Your area of study or degree earned",
      "studyType": "",
      "startDate": "Your start date, in YYYY-MM-DD format",
      "endDate": "Your completion date, in YYYY-MM-DD format",
      "gpa": "",
      "courses": [
        ""
      ]
    }
  ],
  "publications": [
    {
      "name": "Your publication title",
      "publisher": "Publisher name",
      "releaseDate": "Publication date, in YYYY-MM-DD format",
      "website": "The website URL for this publisher or book",
      "summary": "A one-sentence to one-paragraph overview of this publication",
      "isbn": "The ISBN of this publication"
    }
  ],
  "additionalPublications": [
    {
      "name": "Publications that you would like to group separately (e.g. editor rather than author, academic publications, etc)",
      "publisher": "All fields under this section are the same as for 'publications'",
      "releaseDate": "",
      "website": "",
      "summary": "",
      "isbn": ""
    }
  ],
  "publicationsLabel": "Overrides the template label for the 'publications' section (e.g. 'Publications (Author)')",
  "additionalPublicationsLabel": "Overrides the template label for the 'additionalPublications' section (e.g. 'Publications (Technical Reviewer)')",
  "skills": [
    {
      "name": "A category of job skills (e.g. 'Programming Languages')",
      "level": "",
      "keywords": [
        "Keywords under this category (e.g. 'Java', 'C++', etc)"
      ]
    }
  ]
}

XML Support

The command-line front-end also supports an XML representation of the JSON Resume layout, including functionality for converting back and forth between the two representations.

Early prototypes of ResumeFodder were written with the goal of supporting line-break Markdown formatting (e.g. bullet-point lists) within data text fields. So XML support was added from the beginning, since XML is more visually friendly toward line-breaks within text field values.

Mixing style with data proved to be technically challenging, and perhaps a bit misguided conceptually. Soon, the original use cases for Markdown were satisfied by optional extension fields instead. There are no current plans to move forward with embedded formatting within data fields.

XML support is not officially "deprecated". It's there in the command-line front-end if you wish to use it. However, JSON format is generally recommended, and is the only format supported by the online front-end.