Log inSign up
iamseeley avatar
Public
Script
Fork
2 Likes
Readme

⚙️ configuration for hello, resume

this guide will help you configure and use the resume builder to create your resume page.

Ensure that your resume is formatted according to the JSON Resume standard. This is crucial for the resume builder to interpret and render your resume correctly.

If you don't want to take the time to manually format your resume content and set up hosting, try using this: Resume to JSON

1. Configure the Resume JSON

You have two options to provide your resume data:

  1. Resume JSON URL:
  • Point this to your raw resume JSON hosted online.
  • Recommended setups include using Val Town or a GitHub Gist.
  • Example:
resumeJsonUrl: 'https://example.com/resume.json'
  1. Paste Resume JSON:
  • Provide the resume JSON directly within the configuration.
  • Example:
 resumeJson: {
   "basics": { "name": "John Doe" },
   "work": [ ... ]
 }

2. Choose a Theme

Select a theme for your resume. You can use the predefined themes or create your own:

  • Predefined Themes:

    • starterTheme
    • oceanTheme

  • Custom Theme:

    • Customize the styles in the starterTheme or create a new one and import it.

3. Custom Styles (Optional)

If you want to add additional styles, provide a URL to a custom stylesheet:

  • Example:
customStyleUrl: 'https://example.com/styles.css'

4. Set the Section Order

Customize the order of the sections in your resume:

  • Default order:
sectionOrder: ['header', 'summary', 'education', 'work', 'projects', 'volunteer', 'awards', 'certificates', 'publications', 'skills', 'languages', 'interests', 'references']
  • Example custom order:
 sectionOrder: ['header', 'summary', 'projects', 'education', 'work']

5. Add Custom Sections (Optional)

Override any default sections with custom sections:

  • Example:
customSections: {
  header: customHeader
}

6. Show/Hide "Save as PDF" Button

Control the visibility of the "Save asPDF" button:

  • Example:
savePDFIsVisible: true

7. View Your Resume

  • Copy this resumeConfig's module URL and import it in your resumeHandler.
  • Visit the resumeHandler HTTP endpoint to view your resume!
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
import { resumeSetup } from 'https://esm.town/v/iamseeley/resumeSetup';
import { renderResume } from 'https://esm.town/v/iamseeley/renderResume';
import { starterTheme } from 'https://esm.town/v/iamseeley/starterTheme';
import { oceanTheme } from 'https://esm.town/v/iamseeley/oceanTheme';
export const resumeConfig = {
// URL to fetch the resume JSON data. This should point to your raw resume JSON.
// If you want to host your resume JSON somewhere I recommend a setup like this on val town (https://www.val.town/v/iamseeley/resumeDetails) or a github gist.
// You can test out the resume view using my resume: https://iamseeley-resumedetails.web.val.run
resumeJsonUrl: '',
// Alternatively, you can provide the resume JSON directly here.
// Example: { "basics": { "name": "John Doe" }, "work": [ ... ] }
resumeJson: {},
// Theme configuration for the resume.
// This includes a font link and styles for the resume.
// You can customize the styles in the starterTheme or create a new one and import it.
theme: oceanTheme,
// URL to a custom stylesheet if you want to add additional styles.
customStyleUrl: '',
// Order in which you want the sections to appear in the resume.
// Full default order: ['header', 'summary', 'education', 'work', 'projects', 'volunteer', 'awards', 'certificates', 'publications', 'skills', 'languages', 'interests', 'references']
// You can customize this array to change the order of sections.
sectionOrder: ['header', 'summary', 'projects', 'education', 'work'],
// Add custom sections here if you want to override any default sections. You can fork any of the default section vals.
// When creating a custom section be mindful of the resume JSON schema.
// Example:
// customSections: {
// header: customHeader,
//},
customSections: {},
// Set this to true or false to show or hide the "Save as PDF" button.
savePDFIsVisible: true
};
Val Town is a social website to write and deploy JavaScript.
Build APIs and schedule functions from your browser.
Sign up with GitHub
Comments
Nobody has commented on this val yet: be the first!
June 12, 2024