lehmanator / resume.nix Goto Github PK

View Code? Open in Web Editor NEW

2.0 2.0 0.0 1.55 MB

Reproducible personal résumé built & deployed using Nix & jsonresume

Home Page: https://resume.samlehman.dev

Nix 99.97% Shell 0.03%

resume.nix's Introduction

resume.nix

Reproducible personal résumé built & deployed using Nix and jsonresume. Supports a broad number of themes.

Getting started

TODO: Create template

Create your own resume repository and run

nix flake init -t github:Lehmanator/resume.nix

to clone the template to use this flake.

Template will come with a builder package, and a selection of theme packages that are passed to the builder. To build your résumé, first edit the data inside src/resume.nix, then select one of the packages to build.

Each theme will have one of the following packages:

Theme Package: jsonresume-theme-THEMENAME
HTML Builder: jsonresume-html-THEMENAME
PDF Builder: jsonresume-pdf-THEMENAME

For example, to build a PDF document of your résumé, run:

`nix build .#jsonresume-pdf-THEMENAME`

Or to build the HTML static site, run:

`nix build .#jsonresume-html-THEMENAME`

You will then find either resume.pdf or index.html inside ./result directory.

Provided is a default package using a pre-selected theme. This makes building as simple as running: nix build with no extra arguments. To change which theme is used, edit the default package in flake.nix to point to some other config.packages.jsonresume-theme-THEMENAME package.

Included are package definitions for other utils, themes, etc. These may not all be complete or functioning for the time-being.

To list all available packages, run:

nix flake show github:Lehmanator/resume.nix

More Themes

Check NPM for other themes. Most should be fairly trivial to include, and can mostly be copy-and-pasted from other theme package files in packages/jsonresume-themes/THEMENAME

Search NPM packages for jsonresume themes

To-Do

List of features I'd like to implement at some point. Plz help me. Contributions welcome!

Nix Environments

devShell for building, hacking on themes, etc.
hmModules.jsonresume implementing home-manager options to allow setting your data as a part of your homeConfigurations
nixosModules.jsonresume implementing NixOS options to allow deploying your static site & hosting your assets on your machine's networking.domain via a webserver running as a systemd service by declaring what to deploy in your nixosConfigurations.
- TLS certificate generation for self-hosting your static site resume.
- DNS configuration to point your domain at GitHub Pages.

Personal Info

Actually make the data accurate.

Links for later

maartenpaauw/json-resume-to-vcard - Convert jsonresumme to .vcard (Contact file)
GitHub Action: jsonresume-export -
jsonresume/resume-cli - Unmaintained
Fluentdesk/FluentCV - Convert jsonresume to .html, .pdf, .md, & more. Unmaintained
jsonresume/jsonresume-gpt3 -
jsonresume/jsonresume.org -
DrakeAxelrod/jsonresume-service -

Thanks

TaserudConsulting/jsonresume-nix - Flake repo I originally forked this one from. Consider using that project if it better fits your needs. My repo has diverged substantially.
rbardini/resumed - Util that builds the index.html artifacts.
JarvusInnovations/puppeteer-cli - Util that builds the resume.pdf artifacts from index.html
All the jsonresume maintainers, theme developers, and community.

resume.nix's People

Contributors

Stargazers

Watchers

resume.nix's Issues

Cleanup old `jsonresume` packages.

Migrate package loading to Haumea
Hide actual theme NPM packages?
Migrate theme NPM packages to nvfetcher.toml?

Cleanup `flake-parts` options

Migrate extra stuff from flake.nix to subdirectory.
Drop irrelevant flake-parts config?

Create Nix module to allow NixOS systems to run a server hosting the resume static site.

`jsonresume` PDF doesn't generate correctly inside Nix sandbox.

Problem

PDF generation is broken for all current themes inside the Nix sandbox.

End result is that a fully-automated CI/CD process for PDF generation & deployment will build a faulty PDF.

All themes linking remote resources in the HTML will be incorrect in some way, but current themes are completely unreadable.

Cause

Nix sandbox prevents fetching external assets from the internet.

All current themes link to CDN assets for things like bootstrap, font-awesome, other CSS, etc.

The puppeteer-cli PDF generation command: puppeteer print ./index.html resume.pdf tries to render the HTML document in a headless Chromium instance, which cannot reach the assets required by the HTML.

Potential solutions

Prefetch external assets and specify their hash of fixed-output derivation.

Cons:

Each change to JSON data will require changing the hash of the derivation output
Breaks ability to rapidly iterate on resume data using nix build.

Pros:

No patching theme packages.
No rewriting HTML to remove external links

Call `nix build with` --impure` arg in CI workflow.

TODO: How to allow internet inside build sandbox?

Cons:

Adds impurity to builds
packages.jsonresume-pdf* packages cannot be built in pure nix build

Pros:

Minimal changes to build process.

Build PDF in separate GitHub Actions workflow

Only build the HTML in the CI workflow.
Create second workflow for running PDF generation.
Run workflow upon GitHub pages deployment.
Call puppeteer-cli on GitHub pages URL instead of HTML file.

Cons:

Requires separate GitHub Actions workflow.
New GA workflow depends on successful GitHub pages deployment to update the data.
May create extra releases for no-op changes if GitHub pages deployment doesn't successfully update with new HTML.
Requires immediate usage of GitHub releases & new associated GA workflow.
PDF links cannot be relative dirs to Git repo assets, must link to GitHub releases.
Nix workflow and GA workflows will now diverge.

Pros:

Minimal changes within Nix build process

Patch `jsonresume-theme-*` packages to bundle-in all external assets.

Cons:

Must prefetch and retrieve hashes for every jsonresume-theme NPM package.
Must keep patches up-to-date when packages change the linked assets.

Pros:

Might be able to create wrapper for buildNpmPackage that performs this.

Rewrite HTML external asset links during HTML generation derivation.

Cons:

Updates cannot be one-shot updates of source rev + hash

Pros:

Cleanup `packages.rendercv`

Migrate dep: hatchling to separate package file.
Migrate packages.rendercv to separate package file?

Fix puppeteer or replace

PDF generation is failing.

Might want to replace resumed & puppeteer-cli with resume-cli.

Create flake `apps.default` to build CV using `rendercv`

lib to convert CV data from nix to yaml
Test on data
Create pkgs.buildCV
Create apps.default calling pkgs.buildCV

Export builder libs for consumption in external flakes

mkResumePdf
mkResumeHtml

lehmanator / resume.nix Goto Github PK

resume.nix's Introduction

resume.nix

Getting started

More Themes

To-Do

Nix Environments

Personal Info

Links for later

Thanks

resume.nix's People

Contributors

Stargazers

Watchers

resume.nix's Issues

Problem

Cause

Potential solutions

Prefetch external assets and specify their hash of fixed-output derivation.

Call nix build with --impure` arg in CI workflow.

Build PDF in separate GitHub Actions workflow

Patch jsonresume-theme-* packages to bundle-in all external assets.

Rewrite HTML external asset links during HTML generation derivation.

Recommend Projects

Recommend Topics

Recommend Org

Call `nix build with` --impure` arg in CI workflow.

Patch `jsonresume-theme-*` packages to bundle-in all external assets.