Getting Started
Command Line Tool
We've built a CLI (Command Line Interface) which is supported by OSX, Linux and Windows. To create your own resume, installresume-cli
from npm:
npm install -g resume-cli
Note: The official CLI tool isn't that actively maintained. There is an alternative that you might have more success with @rbardini/resumed
Exporting
The command line tool uses an ecosystem of modules that we've open sourced to convert your resume to different formats:
resume export resume.pdf
resume export resume.html
Import from LinkedIn
One of our community members wrote a great Chrome extension to import your LinkedIn Profile.
Download here
Latex
If you want to render a Latex resume there is very well put together project called RenderCV. It has it's own data format for resumes but we have tools to convert your resume.json
to their format.
To convert your resume.jsonnpx @jsonresume/jsonresume-to-rendercv resume.json
Then simplyrendercv render resume.yaml
If you use the registry hosting service, you can access your resume in the RenderCV format e.g.https://registry.jsonresume.org/thomasdavis.rendercv
Maintaining and Deploying Multiple Versions
While unofficial, this approach offers a practical guide for maintaining and deploying multiple resume versions by language and role. You can manually export and publish a "current" version to the registry using any compatible theme.
In this repo, by @HarrySolsem you will find the approach:
- Store multiple resumes files in a dedicated folder.
- Use a root-level
config.json
file to select which resume to deploy. - Commit and push; a Git action workflow replaces the content in
resume.json
with the content from the file selected from the resumes folder based on the resumetype and language settings inconfig.json
. - GitHub Actions then deploy the selected resume to the registry. More information in my readme
Hosting
JSON Resume offers a hosting service that renders yourresume.json
to any theme you would like.
e.g. registry.jsonresume.org/thomasdavis
All you have to do is create a Gist on GitHub namedresume.json
.
Alternatively, you can use the Editor at registry.jsonresume.org
e.g. gist.github.com/thomasdavis/c9dcfa1b37dec07fb2ee7f36d7278105
Our hosting service will automatically detect this when you accessregistry.jsonresume.org/your_github_username
To set a theme, just add to your resume.json
{ "meta": { "theme": "elegant" } }
Use your own repository (instead of a gist)
Basically, you can just make a Github Action, that publishes your gist when you push to your own repo. Example below
EXAMPLE - github.com/thomasdavis/resume
Raw Formats
You can access more raw formats of your resume too!
JSON - registry.jsonresume.org/thomasdavis.json
YAML - registry.jsonresume.org/thomasdavis.yaml
TEXT - registry.jsonresume.org/thomasdavis.txt
QR Service
If you want to generate a QR code that links to your hosted resume, use registry.jsonresume.org/thomasdavis.qr
e.g.