Skip to content
BranchesTags

Repository files navigation

Jesus de Luis - CV System

A data-driven CV that feels like a product, not a static document.

folio-cv logo

This project renders a multilingual CV from JSON, then compiles everything into a single deploy-ready HTML file for GitHub Pages.

Preview

Dark mode and light mode side by side:

Dark Light
CV dark preview CV light preview

Live CV

Add your public URL here:

  • https://<username>.github.io/<repository>/

For this repository, that is typically:

  • https://txitxo0.github.io/folio-cv/

Note on auto-filling in README:

The workflow variable ${{ steps.deployment.outputs.page_url }} only exists at runtime in GitHub Actions and cannot dynamically rewrite README.md on GitHub UI. For a stable README, keep this URL manually maintained.

Why This Exists

Instead of maintaining CV text in multiple documents, the source of truth is one JSON contract:

  1. Easy to edit and version.
  2. Easy to localize (any locale key such as en, es, fr, pt-BR, de, it, etc).
  3. Strictly validated through JSON Schema.
  4. Consistent output across local and CI builds.

Watermarking & Origin Tracking

Every build automatically embeds invisible metadata watermarks in the compiled HTML to prove origin and track distribution:

What is watermarked:

  • Proof of origin (project name: folio-cv)
  • Original author attribution (GitHub user: txitxo0)
  • Build timestamp (UTC ISO 8601)

Where it's stored:

  • Hidden HTML <meta> tags in the document <head>
  • Invisible to the rendered page, visible in HTML source code
  • Preserved in PDF exports (as document properties/metadata)

Why hardcoded: The watermark is intentionally hardcoded to the original project (folio-cv by txitxo0). This serves two purposes:

  1. Proof of origin – Even if someone clones or forks this project, the watermark points back to the original creator.
  2. Distribution tracking – Each build is timestamped, making it possible to trace when a copy was created and distributed.

For users cloning this project: When you clone and build folio-cv, the watermark will still reference the original project. This is intentional and transparent. You are free to modify the JSON data, styles, and functionality, but the watermark remains as attribution to the original project source.

Transparency:

  • Watermark logic is visible in build.py → generate_watermark_metadata() function
  • No obfuscation or hidden code
  • Design choice is documented here in README

Project Map

index.html
build.py
requirements.txt
README.md
assets/
  css/
    cv.css
  js/
    cv.js
  data/
    cv-data.json
    cv-schema.json
  images/
    photo.jpg
dist/
  index.html

Fast Start

Install dependencies:

python -m pip install -r requirements.txt

Run in development mode:

python -m http.server 8080

Open:

  • http://localhost:8080

Build standalone output:

python build.py

Build artifact:

  • dist/index.html

Preview compiled artifact:

cd dist
python -m http.server 8081

Open:

  • http://localhost:8081

Rendering Pipeline

  1. index.html provides structure.
  2. assets/js/cv.js reads assets/data/cv-data.json.
  3. JSON drives header, summary, timeline, skills, formal page, and footer.
  4. build.py validates JSON against assets/data/cv-schema.json.
  5. build.py inlines CSS, JS, JSON, favicon, and local photo into one HTML file.

Data Contract

Primary data source:

  • assets/data/cv-data.json

Validation schema:

  • assets/data/cv-schema.json

The root is multilingual:

{
  "$schema": "./cv-schema.json",
  "cv": {
    "en": { "...": "locale data" },
    "es": { "...": "locale data" },
    "pt-BR": { "...": "locale data" }
  }
}

Locale keys support BCP47-like tags (for example en, es, pt-BR, zh-Hant, en-US).

Locale-Agnostic Usage

This project is locale-agnostic by design. It does not require specific locale names such as en or es.

What this means in practice:

  1. Any valid locale key can be used under cv (es, pt, pt-BR, de, it, ja, etc.).
  2. build.py validates every locale entry against the same schema contract.
  3. build.py inlines local photos for all locales, not only the first one.
  4. Runtime locale selection in assets/js/cv.js is generic and works with any locale key found in the JSON.
  5. <html lang> is set at runtime from the active locale.

Locale resolution order at runtime:

  1. ?lang=<locale> query param (if present and valid).
  2. Saved locale from localStorage (cv-locale) if valid.
  3. First locale key in cv as fallback.

To add a new locale safely:

  1. Add a new node under cv, for example es or pt-BR.
  2. Include all required sections (meta, ui, personal, experience, skills, formal).
  3. Run python build.py to validate schema and generate dist/index.html.
  4. Optional: run python check_build.py to confirm inlined output integrity.

Each locale requires these sections:

  1. meta
  2. ui
  3. personal
  4. experience
  5. skills
  6. formal

JSON Reference

meta

Used by footer and versioning.

Property Type Required Description
lastUpdated string yes Last update label (year or date).
version string yes Human-readable data version.
branding string yes Footer brand text.

ui

All locale-specific labels used by the UI.

Property Type Required
langLabel string yes
tagProfile string yes
tagCareer string yes
tagStack string yes
timelineNow string yes
timelinePast string yes
available string yes
stackNote string yes
updatedPrefix string yes
btnTheme string yes
btnPrint string yes
fWorkExp string yes
fEducation string yes
fLanguages string yes
fCertifications string yes
fTechSkills string yes

personal

Header and summary content.

Property Type Required Description
name string yes Full name.
title string yes Professional headline.
photo string yes Relative path or URL.
location string yes Location label.
contact object yes Contact info block.
summary string yes Main summary paragraph.
summaryImpact string yes Secondary impact paragraph.
summaryImpactEnabled boolean no Toggle for summaryImpact.

contact object:

Property Type Required
phone string yes
email string yes
linkedin string yes
linkedinUrl string (URI) yes

experience[]

Visual timeline cards on page 1.

Property Type Required Notes
id string yes Stable id.
period string yes Date range.
company string yes Company or institution.
role string yes Role title.
description string yes Supporting text.
type string yes work, education, other.
highlight boolean yes Featured styling.
enabled boolean no Visibility toggle.

skills

Data for bars and radar.

skills.levels:

  • object map with numeric string keys ("1", "2", "3") and label values.

skills.categories[]:

Property Type Required Notes
name string yes Category title.
color string yes Hex color #RRGGBB.
pastelColor string no Optional visual override.
skills array yes Child skills.
enabled boolean no Visibility toggle.

skills.categories[].skills[]:

Property Type Required Notes
name string yes Skill label.
level integer yes Minimum value is 1.
enabled boolean no Visibility toggle.

formal

Second-page formal CV content.

Property Type Required
address string yes
workExperience array yes
education array yes
languages array yes
certifications array yes
skills array yes

formal.workExperience[]:

Property Type Required
id string yes
period string yes
company string yes
location string yes
role string yes
description string yes
stack string yes
enabled boolean no

formal.education[]:

Property Type Required
id string yes
period string yes
institution string yes
location string yes
degree string yes
detail string yes
enabled boolean no

formal.languages[]:

Property Type Required
language string yes
level string yes
detail string no

formal.certifications[]:

Property Type Required
name string yes
issuer string yes
year string yes
detail string yes

formal.skills[]:

Property Type Required
category string yes
items string yes

Visibility Toggles

Supported toggles:

  1. experience[].enabled
  2. formal.workExperience[].enabled
  3. formal.education[].enabled
  4. skills.categories[].enabled
  5. skills.categories[].skills[].enabled
  6. personal.summaryImpactEnabled

Behavior:

  1. enabled: false hides the node.
  2. enabled: true shows the node.
  3. If omitted, node is visible (backward compatible).

Example:

{
  "id": "visma",
  "role": "SRE | DevOps Engineer",
  "enabled": false
}

Validation

Validation is enforced in two layers:

  1. Editor-time through "$schema": "./cv-schema.json" in cv-data.json.
  2. Build-time in build.py using jsonschema.

Build fails when:

  1. JSON syntax is invalid.
  2. Data does not comply with schema.

Deployment

GitHub Pages deployment is managed by workflow:

  • .github/workflows/pages.yml

Flow:

  1. Trigger on push to main or manual dispatch.
  2. Run python build.py.
  3. Publish dist/ as Pages artifact.

Troubleshooting

  1. If data does not load in development, do not use file://; run a local server.
  2. If output looks stale, rerun python build.py and hard refresh.
  3. If build reports missing jsonschema, run python -m pip install -r requirements.txt.
  4. If VS Code keeps old schema warnings, save both JSON files and reload window.

License

This project is licensed under the PolyForm Noncommercial License 1.0.0.

  • Forking is allowed.
  • Non-commercial use, modification, and redistribution are allowed.
  • Commercial use is not allowed without prior written permission from the copyright holder.

See LICENSE for details.

About

No description, website, or topics provided.

Resources

Readme
License
Activity

Stars

2 stars

Watchers

0 watching

Forks

0 forks
Report repository

Releases

Packages

Contributors

Languages