Skip to content

Commit 5c33c67

Browse files
authored
feat(theme)!: remove theme auto-load (#4)
1 parent ec96392 commit 5c33c67

File tree

12 files changed

+149
-258
lines changed

12 files changed

+149
-258
lines changed

README.md

+4-7
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,9 @@
77

88
👔 Lightweight [JSON Resume](https://jsonresume.org/) builder, no-frills [alternative to resume-cli](#motivation).
99

10-
- 🗜️ Small (~125 lines)
10+
- 🗜️ Small (~120 LOC)
1111
- 🧩 CLI and Node.js API
1212
- 🤖 TypeScript typings
13-
- 🎨 Theme auto-load
1413
- ⏱️ Async render support
1514
- 🧪 100% code coverage
1615

@@ -20,8 +19,6 @@
2019
npm install resumed jsonresume-theme-even # or your theme of choice
2120
```
2221

23-
ℹ️ Global installation is not supported, as it breaks theme discovery.
24-
2522
## Usage
2623

2724
```console
@@ -59,7 +56,7 @@ Render resume.
5956
**Options:**
6057

6158
- `-o`, `--output`: Output filename (default `resume.html`)
62-
- `-t`, `--theme`: Theme to use, if more than one is installed
59+
- `-t`, `--theme`: Theme to use
6360
- `-h`, `--help`: Display help message
6461

6562
### `init`
@@ -92,9 +89,9 @@ Resumed is a _complete reimplementation_ of resume-cli, using more modern techno
9289

9390
### Theme resolution
9491

95-
Resumed automatically loads and uses the first installed [theme](https://www.npmjs.com/search?q=jsonresume-theme) found when rendering (exporting) a resume, similar to how [Prettier plugins](https://prettier.io/docs/en/plugins.html#using-plugins) work. If no theme is installed, Resumed will guide you on how to proceed. It will also let you know if _multiple_ themes are found, which one it picked, and how to [use another one](#render-default).
92+
Resumed does not install any themes. You must [pick and install one](https://www.npmjs.com/search?q=jsonresume-theme) yourself, and specify your choice via the `--theme` option or the `.meta.theme` field of your resume.
9693

97-
In contrast, resume-cli comes with a theme, and requires specifying what theme to use if the default does not suit you. This is fine for most users, but it ties the default theme package release cycle to that of the CLI, and is a little more verbose.
94+
In contrast, resume-cli comes with a default theme, and only supports the `--theme` option. This is fine for most users, but it ties the default theme package release cycle to that of the CLI, and may be a little more verbose.
9895

9996
### Interface
10097

examples/with-jsonresume-theme/package.json

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,10 @@
33
"type": "module",
44
"scripts": {
55
"init": "resumed init",
6-
"start": "resumed"
6+
"start": "resumed --theme jsonresume-theme-even"
77
},
88
"dependencies": {
99
"jsonresume-theme-even": "^0.17.0",
10-
"resumed": "^1.0.0"
10+
"resumed": "^2.0.0"
1111
}
1212
}

examples/with-local-theme/package.json

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,10 @@
33
"type": "module",
44
"scripts": {
55
"init": "resumed init",
6-
"start": "resumed"
6+
"start": "resumed --theme jsonresume-theme-local"
77
},
88
"dependencies": {
99
"jsonresume-theme-local": "file:./theme",
10-
"resumed": "^1.0.0"
10+
"resumed": "^2.0.0"
1111
}
1212
}

examples/with-node-api/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,6 @@
88
"dependencies": {
99
"jsonresume-theme-even": "^0.17.0",
1010
"puppeteer": "^13.0.0",
11-
"resumed": "^1.0.0"
11+
"resumed": "^2.0.0"
1212
}
1313
}

examples/with-pdf-export/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,6 @@
88
"dependencies": {
99
"jsonresume-theme-even": "^0.17.0",
1010
"puppeteer": "^13.0.0",
11-
"resumed": "^1.0.0"
11+
"resumed": "^2.0.0"
1212
}
1313
}

0 commit comments

Comments
 (0)