Full reference
Every object in the resume format, with types and defaults. This mirrors the schema Rasumi validates against, if it parses here, it renders.
#Resume
The root object.
| Field | Type | Description |
|---|---|---|
basicsrequired | Basics | Identity and contact. Defaults to an empty name with no links. |
sectionsrequired | Section[] | Ordered sections. Defaults to an empty list. |
#Basics
| Field | Type | Description |
|---|---|---|
namerequired | string | Full name. Default: empty string. |
headlineoptional | string | One-line title. Optional. |
emailoptional | string | Contact email. Optional. |
phoneoptional | string | Phone number. Optional. |
locationoptional | string | City / region. Optional. |
linksoptional | Link[] | Labelled URLs. Default: empty list. |
#Link
| Field | Type | Description |
|---|---|---|
labelrequired | string | Link label. Default: empty string. |
urlrequired | string | Link address. Default: empty string. |
#Section
| Field | Type | Description |
|---|---|---|
typeoptional | "experience" | "education" | "skills" | "projects" | "custom" | Section type. Default: custom. |
titleoptional | string | Section heading. Default: empty string. |
entriesoptional | Entry[] | Section items. Default: empty list. |
#Entry
| Field | Type | Description |
|---|---|---|
titlerequired | string | Primary line. Default: empty string. |
subtitleoptional | string | Secondary line. Optional. |
startDateoptional | string | Start, free text. Optional. |
endDateoptional | string | End, free text. Optional. |
descriptionoptional | string | Short paragraph. Optional. |
bulletsoptional | string[] | Accomplishment bullets. Default: empty list. |
#A full document
Putting it together, a complete, valid resume touching every section type. Copy it into the code editor to see it render.
resume.yaml
1basics:2 name: John Doe3 headline: Software Engineer4 email: john.doe@example.com5 location: San Francisco, CA6 links:7 - label: GitHub8 url: github.com/username9sections:10 - type: experience11 title: Experience12 entries:13 - title: Senior Software Engineer14 subtitle: Acme Cloud15 startDate: 202116 endDate: Present17 bullets:18 - Led the migration to a typed API layer.19 - type: education20 title: Education21 entries:22 - title: B.S. Computer Science23 subtitle: State University24 startDate: 201425 endDate: 201826 - type: skills27 title: Skills28 entries:29 - title: Languages30 description: TypeScript, Python, Go31 - type: projects32 title: Projects33 entries:34 - title: Rasumi35 description: A resume builder with a live PDF preview.36 - type: custom37 title: Awards38 entries:39 - title: Best Newcomer, DevConf 2019Resume, Basics, Section, and Entry are the types Rasumi exports internally, the same names you see here map directly to the validated schema.