https://github.com/ab-gh/cv

a project created because all of the JSON Resume Registry templates suck
https://github.com/ab-gh/cv

cv github-pages json

Last synced: 3 months ago
JSON representation

a project created because all of the JSON Resume Registry templates suck

• Host: GitHub
• URL: https://github.com/ab-gh/cv
• Owner: ab-gh
• Created: 2021-07-08T19:28:15.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-06-30T17:32:12.000Z (7 months ago)
• Last Synced: 2024-07-04T00:08:36.884Z (7 months ago)
• Topics: cv, github-pages, json
• Language: HTML
• Homepage: https://ab-gh.github.io/cv/
• Size: 51.8 KB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# cv

[![Deployment](https://github.com/aejb/cv/actions/workflows/deploy.yml/badge.svg?branch=main)](https://github.com/aejb/cv/actions/workflows/deploy.yml)

This script ingests a [JSON Resume](https://jsonresume.org/) compatible `resume.json` and renders it using a custom template with Jinja2

It then deploys the generated `index.html` to the `/pages` branch, which can be configured to serve the page

## requirements

- `Jinja2` (3.0.1)

## usage

1. Fork this repo

2. Clone it locally

3. Replace `resume.json` with your own CV following [the JSON Resume Schema](https://jsonresume.org/schema/)

4. **Ensure you have a `profiles` object inside `basics` with the `network` key as `GitHub` and the `username` key as your own github username.** This allows Jinja to find your raw JSON CV to link it.

5. If you are using the GitHub Pages automation:

    1. Enable the Action on your fork

    2. Push to GitHub (required for automation to trigger)

    3. [Enable GitHub Pages on the `/pages` branch](https://docs.github.com/en/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site)

6. Otherwise:

    1. Run `script.py`

    2. It will output `index.html`

## automation

The [Deploy Action](https://github.com/aejb/cv/blob/main/.github/workflows/deploy.yml) does the following steps on the `push` trigger:

1. Checkout an orphaned `pages` branch

2. Generate `index.html`

3. Commits only `index.html` to origin

## disclaimer

Yes, I know that using Jinja Macros is awful and I could do this way better, but I do not care.

Yes, I know that using `git reset` and empty branches isn't the best, but I wanted the `/pages` branch to only contain `index.html`.