resume renderer

Making requests

Two ways in, same for every endpoint — POST the resume JSON as the request body, or GET with ?source=<url> pointing at a hosted JSON:

# POST the JSON → PDF, saved as "<fullName> - resume.pdf"
curl -X POST 'https://resume.hire-me.now/api/render/pdf' \
  -H 'content-type: application/json' --data @resume.json -OJ

# or GET a hosted resume as HTML
curl 'https://resume.hire-me.now/api/render?source=https://example.com/resume.json'

Endpoints under /api/render:

path	returns
`/api/render` or `/api/render/html`	HTML
`/api/render/pdf`	PDF
`/api/render/validate`	`{ ok, errors, warnings }` — validates without rendering; run it before publishing

Query parameters

param	values	effect
`source`	URL	GET only — fetch the resume JSON from this URL (required on GET)
`paper`	`a4` \| `letter`	page size (default `letter`)
`printable`	`false`	default = paper copy (URLs expanded for print); `false` = electronic (clickable links)
`download`	`true`	force a download (`attachment`) instead of opening inline
`fileName`	template	PDF filename; `{a.b}` placeholders filled from the resume data, e.g. `{main.fullName} - resume - Acme.pdf`
`template`	name	presentation template (default `default`)

Text — the core building block

Most content fields take a Text value. A Text is either a plain string, or an object when a field needs more than words:

field	type	description
`text`	`string`	The text content (optional — a name-only or link-only object is valid). May contain inline HTML (<strong>, <nobr>, <a>).
`class`	`string`	Extra CSS class(es) added to the rendered element — your hook for custom styling.
`url`	`string`	Makes the text a link to this href.
`printUrl`	`string`	URL printed as text in the paper copy (expanded by @media print).
`name`	`string`	Bold label prefix, rendered as "<strong>name:</strong> ".
`leadingLink`	`object`

What it buys you:

Print-aware links — url stays clickable on screen; printUrl is expanded as plain text on the paper copy.
Bold lead-in label — name renders as <strong>name:</strong>.
A leading link before the text (leadingLink), and a per-item CSS class.

So these are all valid Text values:

"A plain string"

{ "text": "Portfolio", "url": "https://example.com" }

{ "name": "Email", "text": "you@example.com" }

`meta (optional — head / SEO)`

Head/SEO data (OpenGraph etc.). Entirely optional — omit it if you just want a PDF.

field	type	description
`summaryShort`	`string`	One-line summary → <meta name="description"> and og:description.
`links`	`object`	Head-only links (favicon, canonical URL, social image).

`links` — item fields

Head-only links (favicon, canonical URL, social image).

field	type	description
`favicon`	`string`	Favicon URL for the HTML page.
`resume`	`string`	Canonical URL of the published resume → og:url.
`avatar`	`object`	Social-preview image (OpenGraph).

Head-only — produces <meta> / OpenGraph tags in <head>, so there is no visible block to preview.

`main (identity)`

Identity block: name + contacts, rendered as the top header.

field	type	description
`fullName`	`string`	Required. Your name → page <h1>, document title, og:title. The only truly required field.
`contacts`	`object[]`	Header contact links (email, phone, profiles, location).

`contacts` — item fields

A single contact line in the header.

field	type	description
`class`	`string`	Contact kind — drives the icon and print ordering: 'linkedin' \| 'phone' \| 'email' \| 'github' \| 'portfolio' \| 'location'.
`text`	`string`	Required. Display text, e.g. the email address or handle.
`url`	`string`	Live href (mailto:, tel:, profile URL).
`printUrl`	`string`	URL printed as text on the paper copy.

example — data

{
  "fullName": "Jane Doe",
  "contacts": [
    {
      "class": "email",
      "text": "jane@example.com",
      "url": "mailto:jane@example.com"
    },
    {
      "class": "phone",
      "text": "+1 (555) 010-0000"
    },
    {
      "class": "location",
      "text": "City, Country"
    },
    {
      "class": "linkedin",
      "text": "in/janedoe",
      "url": "https://www.linkedin.com/in/janedoe"
    }
  ]
}

`type: "title"`

Role headline shown under your name (e.g. "Solution Architect").

field	type	description
`type`	`"title"`	Required.
`class`	`string`	Extra CSS class(es) added to the rendered element — your hook for custom styling.
`hidden`	`boolean \| "print"`	Hide this block. true → hidden everywhere; 'print' → shown on screen but hidden on the PDF/paper copy.
`title`	`Text`	Required.

example — data

{
  "type": "title",
  "title": "Senior Software Engineer"
}

`type: "summary"`

Opening summary paragraph (the elevator pitch under the title).

field	type	description
`type`	`"summary"`	Required.
`class`	`string`	Extra CSS class(es) added to the rendered element — your hook for custom styling.
`hidden`	`boolean \| "print"`	Hide this block. true → hidden everywhere; 'print' → shown on screen but hidden on the PDF/paper copy.
`summary`	`Text`	Required.

example — data

{
  "type": "summary",
  "summary": "A concise opening statement summarizing experience, focus, and strengths."
}

`type: "text"`

Generic content block: optional heading + paragraph + bullet list. Each piece renders only when present.

field	type	description
`type`	`"text"`	Required.
`class`	`string`	Extra CSS class(es) added to the rendered element — your hook for custom styling.
`hidden`	`boolean \| "print"`	Hide this block. true → hidden everywhere; 'print' → shown on screen but hidden on the PDF/paper copy.
`title`	`Text`
`text`	`Text`
`items`	`Text[]`	List items → <ul><li>, or a comma list when inline.
`inline`	`boolean`	Render text + items + notes on one line instead of a list.
`notes`	`string`	Trailing text after the list.
`nobrItems`	`boolean`	Wrap each multi-word item in <nobr> so it never breaks across lines.

example 1 — data

{
  "type": "text",
  "title": "About",
  "text": "A short paragraph of body copy.",
  "items": [
    "First highlight",
    "Second highlight"
  ]
}

example 2 — data

{
  "type": "text",
  "title": "Languages",
  "items": [
    "English",
    "German",
    "Ukrainian"
  ],
  "inline": true
}

`type: "skills"`

Key skills / competencies, one per bullet.

field	type	description
`type`	`"skills"`	Required.
`class`	`string`	Extra CSS class(es) added to the rendered element — your hook for custom styling.
`hidden`	`boolean \| "print"`	Hide this block. true → hidden everywhere; 'print' → shown on screen but hidden on the PDF/paper copy.
`title`	`Text`
`skills`	`Text[]`	Required. Skill bullets; each a Text (often "<strong>Area:</strong> detail").

example — data

{
  "type": "skills",
  "title": "Key Skills",
  "skills": [
    {
      "name": "Focus Area",
      "text": "short description of the skill"
    },
    "Another skill"
  ]
}

`type: "technologies"`

Flat technologies/tools block.

field	type	description
`type`	`"technologies"`	Required.
`class`	`string`	Extra CSS class(es) added to the rendered element — your hook for custom styling.
`hidden`	`boolean \| "print"`	Hide this block. true → hidden everywhere; 'print' → shown on screen but hidden on the PDF/paper copy.
`title`	`Text`
`technologies`	`string \| object[]`	Required. Technologies and tools.

`technologies` — item fields

field	type	description
`list`	`string[]`	Required. Grouped technologies rendered together.

example — data

{
  "type": "technologies",
  "title": "Technologies",
  "technologies": [
    "Language A",
    "Framework B",
    {
      "list": [
        "Tool C",
        "Tool D"
      ]
    }
  ]
}

`type: "experience"`

Professional experience. Consecutive entries at the same company are merged into one block with multiple positions.

field	type	description
`type`	`"experience"`	Required.
`class`	`string`	Extra CSS class(es) added to the rendered element — your hook for custom styling.
`hidden`	`boolean \| "print"`	Hide this block. true → hidden everywhere; 'print' → shown on screen but hidden on the PDF/paper copy.
`title`	`Text`
`experience`	`object \| string[]`	Required. Work history, newest first. A plain string between items is a relocation marker, rendered as a captioned <hr>.

`experience` — item fields

One job: company, role, dates, description, achievements, tech.

field	type	description
`company`	`string \| null`	Required. Employer name. null = freelance/independent.
`project`	`string \| null`	Product/client shown after the role as "› project".
`position`	`string`	Required. Job title.
`location`	`string`	City, country.
`startDate`	`string`	Required. ISO date as year-month, e.g. "2021-06".
`endDate`	`string \| null`	Required. ISO date as year-month, e.g. "2021-06".
`description`	`Text`
`achievements`	`Text[]`	Bullet list of accomplishments.
`technologies`	`string[]`	Tech/tools used, joined into a "Technologies:" line.
`hidden`	`boolean \| "print"`	Hide this block. true → hidden everywhere; 'print' → shown on screen but hidden on the PDF/paper copy.
`isFreelance`	`boolean`	Tags the entry as freelance (shows a "(freelance)" marker).
`class`	`string`	Extra CSS class(es) added to the rendered element — your hook for custom styling.

example — data

{
  "type": "experience",
  "title": "Experience",
  "experience": [
    {
      "company": "Example Company",
      "position": "Job Title",
      "location": "City, Country",
      "startDate": "2021-01",
      "endDate": null,
      "description": "A short summary of the role and scope.",
      "achievements": [
        "A notable result or accomplishment",
        "Another measurable outcome"
      ],
      "technologies": [
        "Tech A",
        "Tech B"
      ]
    }
  ]
}

`type: "projects"`

Selected projects / portfolio highlights.

field	type	description
`type`	`"projects"`	Required.
`class`	`string`	Extra CSS class(es) added to the rendered element — your hook for custom styling.
`hidden`	`boolean \| "print"`	Hide this block. true → hidden everywhere; 'print' → shown on screen but hidden on the PDF/paper copy.
`title`	`Text`
`projects`	`Text[]`	Required. Selected projects; each a Text (string, or object with a link/label).

example — data

{
  "type": "projects",
  "title": "Selected Projects",
  "projects": [
    {
      "name": "Project Name",
      "text": "a short description of the project",
      "url": "https://example.com"
    },
    {
      "leadingLink": {
        "text": "Link to project",
        "url": "https://resume.hire-me.now/render",
        "printUrl": "resume.hire-me.now/render"
      },
      "text": "service that renders a resume from a JSON schema supporting multiple formats and themes",
      "class": "print-condensed-01"
    },
    "Another project"
  ]
}

`type: "volunteering"`

Volunteer / community work.

field	type	description
`type`	`"volunteering"`	Required.
`class`	`string`	Extra CSS class(es) added to the rendered element — your hook for custom styling.
`hidden`	`boolean \| "print"`	Hide this block. true → hidden everywhere; 'print' → shown on screen but hidden on the PDF/paper copy.
`title`	`Text`
`volunteering`	`object[]`	Required. Volunteering entries, newest first.

`volunteering` — item fields

One volunteering entry.

field	type	description
`project`	`string`	Initiative/project name, shown before the role.
`position`	`string`	Required. Your role.
`startDate`	`string`	ISO date as year-month, e.g. "2021-06".
`endDate`	`string \| null`	ISO date as year-month, e.g. "2021-06".
`description`	`Text`
`hidden`	`boolean \| "print"`	Hide this block. true → hidden everywhere; 'print' → shown on screen but hidden on the PDF/paper copy.
`class`	`string`	Extra CSS class(es) added to the rendered element — your hook for custom styling.

example — data

{
  "type": "volunteering",
  "title": "Volunteering",
  "volunteering": [
    {
      "position": "Role",
      "project": "Organization",
      "startDate": "2022-01",
      "endDate": null,
      "description": "A short summary of the contribution."
    }
  ]
}

`type: "education"`

Education, courses, and certifications.

field	type	description
`type`	`"education"`	Required.
`class`	`string`	Extra CSS class(es) added to the rendered element — your hook for custom styling.
`hidden`	`boolean \| "print"`	Hide this block. true → hidden everywhere; 'print' → shown on screen but hidden on the PDF/paper copy.
`title`	`Text`
`education`	`object[]`	Required. Education entries, newest first.

`education` — item fields

One degree / course / certification.

field	type	description
`position`	`string`	Required. Degree, course, or certification name.
`company`	`string`	Institution / school.
`project`	`string`	Department or specialization.
`location`	`string`	City, country.
`startDate`	`string`	ISO date as year-month, e.g. "2021-06".
`endDate`	`string`	ISO date as year-month, e.g. "2021-06".
`description`	`Text`
`hidden`	`boolean \| "print"`	Hide this block. true → hidden everywhere; 'print' → shown on screen but hidden on the PDF/paper copy.
`class`	`string`	Extra CSS class(es) added to the rendered element — your hook for custom styling.

example — data

{
  "type": "education",
  "title": "Education",
  "education": [
    {
      "position": "Degree or Certification",
      "company": "Institution",
      "location": "City",
      "startDate": "2010",
      "endDate": "2014"
    }
  ]
}

Styling system

There are three render contexts, each a class prefix: screen-* (on-screen), mobile-* (≤ 600px), print-* (PDF / paper). Utility class names follow {context?}-{function}-{impact?} — the impact is the value with a leading zero for the integer part (005 = 0.05, 11 = 1.1).

The class field — on any section, item, or Text — is your styling hook.

Typography

screen	mobile	print	effect
`text-08`			font-size 0.8rem (children too)
`text-09`			font-size 0.9rem
`text-11`			font-size 1.1rem
`text-12`			font-size 1.2rem
`unaccented`			font-weight: normal
`screen-expanded-01`	`mobile-expanded-01`	`print-expanded-01`	letter-spacing +0.1pt
`screen-condensed-004`	—	`print-condensed-004`	letter-spacing −0.04pt
`screen-condensed-005`	`mobile-condensed-005`	`print-condensed-005`	letter-spacing −0.05pt
`screen-condensed-01`	`mobile-condensed-01`	`print-condensed-01`	letter-spacing −0.1pt
`screen-condensed-015`	`mobile-condensed-015`	—	letter-spacing −0.15pt
`screen-condensed-02`	`mobile-condensed-02`	`print-condensed-02`	letter-spacing −0.2pt
—	`mobile-condensed-03`	—	letter-spacing −0.3pt

Visibility & spacing

screen	print	effect
`hidden`		remove entirely
`margins-05-0`		margin 0.5rem top & bottom
—	`print-hidden`	hide on paper only (same as `hidden: "print"`)
—	`print-no-break-block`	keep the block together on one page

resume renderer

Making requests

Query parameters

Text — the core building block

Envelope

`meta (optional — head / SEO)`

`links` — item fields

`main (identity)`

`contacts` — item fields

Sections

`type: "title"`

`type: "summary"`

`type: "text"`

`type: "skills"`

`type: "technologies"`

`technologies` — item fields

`type: "experience"`

`experience` — item fields

`type: "projects"`

`type: "volunteering"`

`volunteering` — item fields

`type: "education"`

`education` — item fields

Styling system

Typography

Visibility & spacing

Making requests

Query parameters

Text — the core building block

Envelope

meta (optional — head / SEO)

links — item fields

main (identity)

contacts — item fields

Sections

type: "title"

type: "summary"

type: "text"

type: "skills"

type: "technologies"

technologies — item fields

type: "experience"

experience — item fields

type: "projects"

type: "volunteering"

volunteering — item fields

type: "education"

education — item fields

Styling system

Typography

Visibility & spacing

`meta (optional — head / SEO)`

`links` — item fields

`main (identity)`

`contacts` — item fields

`type: "title"`

`type: "summary"`

`type: "text"`

`type: "skills"`

`type: "technologies"`

`technologies` — item fields

`type: "experience"`

`experience` — item fields

`type: "projects"`

`type: "volunteering"`

`volunteering` — item fields

`type: "education"`

`education` — item fields