84 lines
2.5 KiB
Markdown
84 lines
2.5 KiB
Markdown
# Resume Generator
|
|
|
|
Generates professional Word documents (.docx) from JSON Resume format using the `docx` npm package.
|
|
|
|
## Prerequisites
|
|
|
|
- Node.js (v14 or higher recommended)
|
|
- npm
|
|
|
|
## Installation
|
|
|
|
```bash
|
|
npm install
|
|
```
|
|
|
|
## Updating Your Resume
|
|
|
|
Edit `resume.json` to update your resume content. The file follows the [JSON Resume schema](https://jsonresume.org/schema/).
|
|
|
|
### Sections
|
|
|
|
**basics** - Personal information and contact details
|
|
- `name` - Your full name
|
|
- `label` - Professional title/headline
|
|
- `email`, `phone`, `url` - Contact information
|
|
- `summary` - Professional summary paragraph
|
|
- `location` - City, region, country
|
|
- `profiles` - Social/professional network links (LinkedIn, GitHub, etc.)
|
|
|
|
**work** - Employment history (array)
|
|
- `name` - Company name
|
|
- `position` - Job title
|
|
- `location` - Work location
|
|
- `startDate`, `endDate` - Dates in YYYY-MM format (omit endDate for current position)
|
|
- `summary` - Role description
|
|
- `highlights` - Array of accomplishments/responsibilities
|
|
|
|
**education** - Academic background (array)
|
|
- `institution` - School name
|
|
- `area` - Field of study
|
|
- `studyType` - Degree type (e.g., "Bachelor", "Master")
|
|
- `startDate`, `endDate` - Dates in YYYY-MM format
|
|
- `score` - GPA or honors (optional)
|
|
|
|
**certificates** - Professional certifications (array)
|
|
- `name` - Certification name
|
|
- `issuer` - Issuing organization
|
|
- `date` - Date obtained (YYYY-MM format)
|
|
|
|
**awards** - Recognition and awards (array)
|
|
- `title` - Award name
|
|
- `awarder` - Granting organization
|
|
- `date` - Date received
|
|
- `summary` - Description (optional)
|
|
|
|
**skills** - Technical and professional skills (array)
|
|
- `name` - Skill category (e.g., "Security Tools", "Programming")
|
|
- `level` - Proficiency level (optional)
|
|
- `keywords` - Array of specific skills in this category
|
|
|
|
## Running the Generator
|
|
|
|
```bash
|
|
node generate_resume.js
|
|
```
|
|
|
|
**Output:** `Phillip_Tarrant_Resume_{YEAR}.docx` in the project directory.
|
|
|
|
## Customization
|
|
|
|
To modify the document formatting, edit `generate_resume.js`:
|
|
|
|
- **Output filename:** Change `OUTPUT_FILE` on line 11
|
|
|
|
- **Fonts:** Change the `font` property in `TextRun` objects (default: Arial)
|
|
- **Margins:** Adjust values in `sections[0].properties.page.margin` (units are DXA, 1440 = 1 inch)
|
|
- **Text sizes:** Modify `size` in `TextRun` objects (units are half-points, e.g., 22 = 11pt)
|
|
- **Spacing:** Adjust `spacing: { before: X, after: Y }` on Paragraph elements
|
|
|
|
## Resources
|
|
|
|
- [JSON Resume Schema](https://jsonresume.org/schema/) - Full schema documentation
|
|
- [docx npm package](https://docx.js.org/) - Document generation library docs
|