Skip to content

metaory/jsonresume-theme-legacy

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

55 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

π‘ƒβŒ„πŒ’βŒƒπ£―πΉ

jsonresume theme
demo | sample.pdf


USAGE

# 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

Tip

Optimizations

for images npm run optimize:images or bash optimize-images.sh

compress final pdf npm run optimize:pdf or bash compress-pdf.sh out/private.pdf

each optimizations comes with its own dependencies, read their scripts to learn more


CUSTOMIZATION

Icons

Note

Iconify is used for icons.

Note

The default icon map is defined in 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;

{
  // ...
  "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

{
  "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 is used for pdf exports

If you use the proprietary google-chrome you have to update the build:private script accordingly


Note

Only tested on Linux

Reconsider your life choices if you're running πŸ’© Windows!


LICENSE

MIT

About

Modern Vite-based JSONResume theme with Iconify integration, customizable colors, and PDF export capabilities

Topics

Resources

License

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Contributors 2

  •  
  •