Skip to the content

The shape of the file

A resume is one Markdown file with your name, a headline, contacts and sections, plus a few directives for the parts Markdown has no word for.

View as Markdown

A resume in Rejarsume is one Markdown file. It is ordinary Markdown with a few extra lines, called directives, for the things a heading and a list cannot say, such as a job with a title, a place and dates. Everything on the paper comes from this file, and every edit you make on the paper is written back into it, so a file in this shape is a finished resume whoever or whatever typed it.

resume.md

# Ada Lovelace

Mathematician, and the first programmer

::contact[ada@example.com]{icon="envelope" href="mailto:ada@example.com"}
::contact[London, UK]{icon="map-pin"}

## Summary

Wrote the first published algorithm, for a machine that was never built.

## Experience

:::entry{title="Translator and annotator" subtitle="Analytical Engine notes" location="London" start="1842" end="1843"}
Wrote the notes that held the first program.

- Published the notes alongside the translation
:::

## Skills

::tags[Mathematics, Analysis, Writing]

The name and the headline

# is your name. There is one, it comes first, and it is the only thing the file has to have. The paragraph under it is the headline: the single line that sits beneath your name.

Contacts

Between the name and the first section, each ::contact line is one contact detail. See Contacts.

Sections

## opens a section, and its text is that section's title. These titles also tell a template what kind of section it is:

  • Summary, which is also read from About, Profile and Objective
  • Experience, also Work experience, Professional experience, Employment and Work history
  • Education
  • Skills, also Technical skills
  • Projects
  • Certifications, also Certificates
  • Awards, also Honours and Honors
  • Publications
  • Languages
  • Interests, also Hobbies

The Indonesian titles for these are recognised too, such as Ringkasan, Pengalaman, Pendidikan and Keahlian. Any other title is fine and is drawn the same way, as a custom section. A title is matched in full and ignoring capital letters, never loosely, because a wrong guess would change how a template lays the section out.

A section keeps its identity when you rename its heading. Its icon, whether it is hidden and its own style settings are kept by Rejarsume and not written in the Markdown, and they stay with the section through the rename.

The directives are listed in the table below.

A file written with ### headings instead works as pasted: the shallowest heading level in the file is taken as the section level, and it is tidied on the first save.

What the directives are

DirectiveWhat it is for
::contactOne contact detail, in the header
:::entryA job, a degree or a project, with its facts
::tagsA row of short labels, for skills and tools
::labelOne line with an icon in front of it
:iconAn icon inside a line of text
::imageA picture
::pagebreakA forced page break

The directive reference lists every attribute. Anything that is not a directive is ordinary Markdown, covered in Everything else is ordinary Markdown.

Styling is not in the file

The Markdown holds content only. Fonts, colours and margins are set in the Style tab and in your own CSS, so you can change how a resume looks without touching a word of it.