diff --git a/.github/workflows/docker-build.yml b/.github/workflows/docker-build.yml
index dc3312143..6b73b7f20 100644
--- a/.github/workflows/docker-build.yml
+++ b/.github/workflows/docker-build.yml
@@ -4,7 +4,6 @@ on:
workflow_dispatch:
push:
branches: [ main ]
- tags: [ "v*.*.*" ]
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
diff --git a/README.md b/README.md
index 03eeef286..3ec6b877a 100644
--- a/README.md
+++ b/README.md
@@ -29,7 +29,7 @@
-
+
+
+
+
+
+
+Good candidates for multi-column layouts:
+
+| Section | Recommended Columns |
+|---------|---------------------|
+| Skills | > 2 columns |
+| Languages | > 3 columns |
+| Interests | > 2 columns |
+| Profiles | > 3 columns |
+| Certifications (if brief) | > 2 columns |
+
+HTML-formatted summary content here.
" +} +``` + +## Sections + +All sections share a common structure: + +```json +{ + "title": "Section Title", + "columns": 1, + "hidden": false, + "items": [ ... ] +} +``` + +### Experience Items + +```json +{ + "id": "uuid-here", + "hidden": false, + "company": "Acme Corp", + "position": "Software Engineer", + "location": "San Francisco, CA", + "period": "Jan 2020 - Present", + "website": { "url": "https://acme.com", "label": "" }, + "description": "Description of the project and your contributions.
" +} +``` + +### Language Items + +```json +{ + "id": "uuid-here", + "hidden": false, + "language": "English", + "fluency": "Native", + "level": 5 +} +``` + +Fluency examples: Native, Fluent, Conversational, Basic, or CEFR levels (A1-C2) + +### Certification Items + +```json +{ + "id": "uuid-here", + "hidden": false, + "title": "AWS Solutions Architect", + "issuer": "Amazon Web Services", + "date": "March 2023", + "website": { "url": "https://aws.amazon.com/certification/", "label": "Verify" }, + "description": "" +} +``` + +### Award Items + +```json +{ + "id": "uuid-here", + "hidden": false, + "title": "Employee of the Year", + "awarder": "Acme Corp", + "date": "2022", + "website": { "url": "", "label": "" }, + "description": "" +} +``` + +### Publication Items + +```json +{ + "id": "uuid-here", + "hidden": false, + "title": "Research Paper Title", + "publisher": "IEEE", + "date": "2021", + "website": { "url": "https://doi.org/...", "label": "DOI" }, + "description": "" +} +``` + +### Volunteer Items + +```json +{ + "id": "uuid-here", + "hidden": false, + "organization": "Local Food Bank", + "location": "San Francisco, CA", + "period": "2020 - Present", + "website": { "url": "", "label": "" }, + "description": "Volunteer activities and impact.
" +} +``` + +### Interest Items + +```json +{ + "id": "uuid-here", + "hidden": false, + "icon": "", + "name": "Photography", + "keywords": ["Landscape", "Portrait", "Street"] +} +``` + +### Reference Items + +```json +{ + "id": "uuid-here", + "hidden": false, + "name": "Jane Smith", + "position": "Engineering Manager at Acme Corp", + "website": { "url": "https://linkedin.com/in/janesmith", "label": "LinkedIn" }, + "phone": "+1 (555) 987-6543", + "description": "Optional testimonial or quote.
" +} +``` + +### Profile Items (Social Links) + +```json +{ + "id": "uuid-here", + "hidden": false, + "icon": "linkedin-logo", + "network": "LinkedIn", + "username": "johndoe", + "website": { "url": "https://linkedin.com/in/johndoe", "label": "" } +} +``` + +Icons use @phosphor-icons/web names. Common icons: `linkedin-logo`, `github-logo`, `twitter-logo`, `globe` + +## Metadata + +### Template Options + +Available templates: `azurill`, `bronzor`, `chikorita`, `ditto`, `ditgar`, `gengar`, `glalie`, `kakuna`, `lapras`, `leafish`, `onyx`, `pikachu`, `rhyhorn` + +### Layout Configuration + +```json +{ + "sidebarWidth": 35, + "pages": [ + { + "fullWidth": false, + "main": ["profiles", "summary", "experience", "education", "projects"], + "sidebar": ["skills", "languages", "certifications", "interests"] + } + ] +} +``` + +Section IDs for layout: `profiles`, `experience`, `education`, `projects`, `skills`, `languages`, `interests`, `awards`, `certifications`, `publications`, `volunteer`, `references`, `summary` + +### Page Settings + +```json +{ + "gapX": 4, + "gapY": 6, + "marginX": 14, + "marginY": 12, + "format": "a4", + "locale": "en-US", + "hideIcons": false +} +``` + +Format options: `a4`, `letter` + +### Design Settings + +```json +{ + "colors": { + "primary": "rgba(220, 38, 38, 1)", + "text": "rgba(0, 0, 0, 1)", + "background": "rgba(255, 255, 255, 1)" + }, + "level": { + "icon": "star", + "type": "circle" + } +} +``` + +Level types: `hidden`, `circle`, `square`, `rectangle`, `rectangle-full`, `progress-bar`, `icon` + +### Typography + +```json +{ + "body": { + "fontFamily": "IBM Plex Serif", + "fontWeights": ["400", "500"], + "fontSize": 10, + "lineHeight": 1.5 + }, + "heading": { + "fontFamily": "IBM Plex Serif", + "fontWeights": ["600"], + "fontSize": 14, + "lineHeight": 1.5 + } +} +``` + +Font family must be available on Google Fonts. Font weights: 100-900. + +### CSS Customization + +```json +{ + "enabled": false, + "value": "" +} +``` + +## Custom Sections + +Custom sections extend the base section structure with additional fields: + +```json +{ + "id": "uuid-here", + "title": "Custom Section Title", + "columns": 1, + "hidden": false, + "type": "experience", + "items": [ ... ] +} +``` + +The `type` field determines the item schema. Valid types: `profiles`, `experience`, `education`, `projects`, `skills`, `languages`, `interests`, `awards`, `certifications`, `publications`, `volunteer`, `references` + +## UUID Generation + +All `id` fields require valid UUIDs version 7. If available, use 'v7()' from the 'uuid' package to generate a valid UUID. Otherwise, fallback to generating a valid UUID v4 using crypto.randomUUID() from 'node' or the equivalent. + +## HTML Content + +Fields marked as "HTML-formatted string" accept basic HTML: +- `` for paragraphs +- `