jsonresume-theme-academic 1.3.2 → 1.3.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +105 -97
- package/package.json +13 -3
package/README.md
CHANGED
|
@@ -1,97 +1,105 @@
|
|
|
1
|
-
# jsonresume-theme-academic
|
|
2
|
-
|
|
3
|
-
> Academic serif theme for [JSON Resume](https://jsonresume.org) with EB Garamond typography, small caps headings, and gold accents. Designed for print and PDF.
|
|
4
|
-
|
|
5
|
-
[](https://www.npmjs.com/package/jsonresume-theme-academic)
|
|
6
|
-
[ with EB Garamond typography, small caps headings, and gold accents. Designed for print and PDF.
|
|
4
|
+
|
|
5
|
+
[](https://www.npmjs.com/package/jsonresume-theme-academic)
|
|
6
|
+
[](https://www.npmjs.com/package/jsonresume-theme-academic)
|
|
7
|
+
[](LICENSE)
|
|
8
|
+
[](https://www.typescriptlang.org/)
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
## Features
|
|
13
|
+
|
|
14
|
+
- Academic serif typography (EB Garamond)
|
|
15
|
+
- A4 print layout with precise margins
|
|
16
|
+
- Built in HTML sanitization (XSS safe)
|
|
17
|
+
- Customizable section headings via `meta.headings`
|
|
18
|
+
- Zero runtime dependencies
|
|
19
|
+
- ESM + CJS + UMD builds with TypeScript declarations
|
|
20
|
+
|
|
21
|
+
## Quick Start
|
|
22
|
+
|
|
23
|
+
### With resumed (recommended)
|
|
24
|
+
|
|
25
|
+
```bash
|
|
26
|
+
npm install jsonresume-theme-academic
|
|
27
|
+
npx resumed render resume.json --theme jsonresume-theme-academic
|
|
28
|
+
# → resume.html ready
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
### With resume-cli
|
|
32
|
+
|
|
33
|
+
```bash
|
|
34
|
+
npm install -g resume-cli jsonresume-theme-academic
|
|
35
|
+
resume export resume.pdf --theme academic
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
### Programmatic Usage
|
|
39
|
+
|
|
40
|
+
```typescript
|
|
41
|
+
import { render, pdfRenderOptions } from 'jsonresume-theme-academic';
|
|
42
|
+
|
|
43
|
+
const html = render(resumeJson);
|
|
44
|
+
// html is a self-contained HTML document
|
|
45
|
+
|
|
46
|
+
// For Puppeteer PDF rendering:
|
|
47
|
+
await page.pdf(pdfRenderOptions);
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
## Customization
|
|
51
|
+
|
|
52
|
+
### Section Headings
|
|
53
|
+
|
|
54
|
+
Override default headings via `meta.headings`:
|
|
55
|
+
|
|
56
|
+
```json
|
|
57
|
+
{
|
|
58
|
+
"meta": {
|
|
59
|
+
"headings": {
|
|
60
|
+
"experience": "Professional Experience",
|
|
61
|
+
"skills": "Technical Skills",
|
|
62
|
+
"education": "Academic Background"
|
|
63
|
+
}
|
|
64
|
+
}
|
|
65
|
+
}
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
Available keys: `skills`, `experience`, `projects`, `education`, `volunteer`, `certifications`, `additional`
|
|
69
|
+
|
|
70
|
+
### PDF Rendering Options
|
|
71
|
+
|
|
72
|
+
The exported `pdfRenderOptions` provides optimized settings for Puppeteer/Gotenberg:
|
|
73
|
+
|
|
74
|
+
```typescript
|
|
75
|
+
{
|
|
76
|
+
mediaType: 'print',
|
|
77
|
+
format: 'A4',
|
|
78
|
+
margin: { top: '12mm', right: '14mm', bottom: '12mm', left: '14mm' }
|
|
79
|
+
}
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
## Development
|
|
83
|
+
|
|
84
|
+
```bash
|
|
85
|
+
git clone https://github.com/ebenezer-isaac/jsonresume-theme-academic.git
|
|
86
|
+
cd jsonresume-theme-academic
|
|
87
|
+
npm install
|
|
88
|
+
npm run dev # Start dev server
|
|
89
|
+
npm test # Run tests
|
|
90
|
+
npm run build # Build ESM + CJS + UMD
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
## Community
|
|
94
|
+
|
|
95
|
+
This theme is part of the open-source toolkit from [LLM Conveyors](https://llmconveyors.com), an AI-powered career platform that uses this theme for generating polished, print-ready resumes. We open-sourced it so anyone building with JSON Resume can have a production-quality academic theme out of the box.
|
|
96
|
+
|
|
97
|
+
If you're using this theme in your project, we'd love to hear about it — open an issue or start a discussion!
|
|
98
|
+
|
|
99
|
+
## Contributing
|
|
100
|
+
|
|
101
|
+
See [CONTRIBUTING.md](CONTRIBUTING.md)
|
|
102
|
+
|
|
103
|
+
## License
|
|
104
|
+
|
|
105
|
+
MIT
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "jsonresume-theme-academic",
|
|
3
|
-
"version": "1.3.
|
|
3
|
+
"version": "1.3.3",
|
|
4
4
|
"description": "Academic serif theme for JSON Resume with EB Garamond typography, small caps headings, and gold accents. Designed for print and PDF.",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "dist/index.cjs",
|
|
@@ -39,9 +39,15 @@
|
|
|
39
39
|
"serif",
|
|
40
40
|
"garamond",
|
|
41
41
|
"curriculum-vitae",
|
|
42
|
-
"pdf"
|
|
42
|
+
"pdf",
|
|
43
|
+
"resume-builder",
|
|
44
|
+
"resume-template",
|
|
45
|
+
"print",
|
|
46
|
+
"typography",
|
|
47
|
+
"a4",
|
|
48
|
+
"puppeteer"
|
|
43
49
|
],
|
|
44
|
-
"author": "Ebenezer",
|
|
50
|
+
"author": "Ebenezer Isaac",
|
|
45
51
|
"license": "MIT",
|
|
46
52
|
"repository": {
|
|
47
53
|
"type": "git",
|
|
@@ -51,6 +57,10 @@
|
|
|
51
57
|
"bugs": {
|
|
52
58
|
"url": "https://github.com/ebenezer-isaac/jsonresume-theme-academic/issues"
|
|
53
59
|
},
|
|
60
|
+
"funding": {
|
|
61
|
+
"type": "individual",
|
|
62
|
+
"url": "https://llmconveyors.com"
|
|
63
|
+
},
|
|
54
64
|
"engines": {
|
|
55
65
|
"node": ">=20"
|
|
56
66
|
},
|