https://github.com/metaory/jsonresume-theme-legacy
Legacy JSONResume handlebars port to Vite
https://github.com/metaory/jsonresume-theme-legacy
json-resume jsonresume jsonresume-theme
Last synced: about 1 year ago
JSON representation
Legacy JSONResume handlebars port to Vite
- Host: GitHub
- URL: https://github.com/metaory/jsonresume-theme-legacy
- Owner: metaory
- License: mit
- Created: 2024-09-09T18:18:31.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2025-01-27T19:09:27.000Z (over 1 year ago)
- Last Synced: 2025-04-13T13:55:36.995Z (about 1 year ago)
- Topics: json-resume, jsonresume, jsonresume-theme
- Language: Handlebars
- Homepage: https://metaory.github.io/jsonresume-theme-legacy/
- Size: 26.4 MB
- Stars: 12
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
---
## USAGE
```sh
# clone
git clone git@github.com:metaory/jsonresume-theme-legacy.git
# navigate
cd jsonresume-theme-legacy
# install dependencies
pnpm install
# run development
pnpm run dev
# view sample page
http://localhost:5173
# build sample pdf
pnpm run build:sample
# duplicate the resume data
cp src/pages/index.json src/pages/private.json
# update the resume data
nvim src/pages/private.json
# view newly created page
http://localhost:5173/private
# build private pdf
pnpm run build:private
```
---
## CUSTOMIZATION
### Icons
> [!NOTE]
> [Iconify](https://icon-sets.iconify.design) is used for icons.
> [!NOTE]
> The default icon map is defined in [src/pages/index.json](https://github.com/metaory/jsonresume-theme-legacy/blob/master/src/pages/index.json)
> Under `meta.themeOptions.iconMap`
> [!TIP]
> You can add/overwrite by adding the desired key value in your `private.json`
> [!TIP]
> You can use icons from any collection
For example to add new icon
for keyword `system-design` to have `mingcute:ghost-line` icon,
and to overwrite the `javascript` icon;
```jsonc
{
// ...
"meta": {
"themeOptions": {
"iconMap": {
"system-design": "mingcute:ghost-line",
"javascript": "fluent:code-js-rectangle-16-filled"
}
// ...
}
}
}
```
> [!IMPORTANT]
> Make sure the keys in `iconMap` are all lowercase
>
> While the keyword do NOT have to be lowercase
> [!TIP]
> the iconify icon name can be in either form
>
> - `hugeicons:ai-view`
> - `hugeicons--ai-view`
> [!CAUTION]
> a complete process restart is needed if overwriting existing icons
---
### Images
> [!TIP]
> Image paths can be remote or local
>
> Local path is from root
```jsonc
{
"basics": {
"name": "John Doe",
"label": "Programmer",
// remote images
"image": "https://avatars.githubusercontent.com/u/9919",
// local private ignored assets
"logo": "/.dev/my-private-logo.png",
// ...
},
// ...
}
```
---
### Summary
> [!TIP]
> The `basics.summary` is placed as **raw HTML**
---
### Titles
> [!TIP]
> You can change section titles
>
> Under `meta.themeOptions.sectionTitles`
---
### Colors
> [!TIP]
> ~~You can overwrite color values~~
>
> ~~Under `meta.themeOptions.colors`~~
>
> 🚧 Not implemented
---
### Troubleshooting
> [!CAUTION]
> You need the dev script running before running the pdf build script
---
> [!WARNING]
> `sh: line 1: chromium: command not found`
>
> [chromium](https://chromium.org) is used for pdf exports
>
> If you use the proprietary `google-chrome`
> you have to update the [build:private](https://github.com/metaory/jsonresume-theme-legacy/blob/master/package.json) script accordingly
---
> [!NOTE]
> Only tested on Linux
>
> Reconsider your life choices if you're running 💩 Windows!
---
## LICENSE
[MIT](LICENSE)
