jekyll-theme-resume 1.3.0

data/_layouts/resume.html

@@ -0,0 +1,238 @@
+{%- assign lang = page.lang | default: site.default_lang | default: 'en' -%}
+{%- assign locale = site.data.locales[lang] | default: site.data.locales[site.default_lang] -%}
+{%- assign lang_cfg = site.languages[lang] -%}
+{% include data-loader.html path=lang_cfg.data_path %}
+<!DOCTYPE html>
+<html lang="{{ lang | escape }}" dir="{{ locale.direction }}">
+    <!-- This page was last updated on {{ "now" | date: "%Y-%m-%d %H:%M:%S" }}Z -->
+
+    <head>
+        {%- comment -%}
+        Head Assets:
+        - shared-head: Shared charset, viewport, SEO base, and favicon links
+        - Locale web font (locale.font_url) and locale-driven CSS (assets/css/cv-{{ locale.direction }}.css)
+        - seo: Jekyll SEO tag for social graph, search indexing, and canonical URLs
+        - analytics-head: Google Analytics / GTM tracking scripts (optional)
+        {%- endcomment -%}
+        {% include shared-head.html %}
+
+        {% if site.disable_google_fonts != true and site.resume_theme != 'no-custom-fonts' %}
+            {% if locale.font_url != "" %}
+                <!-- Locale web font, from _data/locales/{{ lang }}.yml -->
+                <link rel="preconnect" href="https://fonts.googleapis.com">
+                <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
+                <link href="{{ locale.font_url }}" rel="stylesheet">
+            {% else %}
+                <!-- Default web font (Lora + Open Sans) for locales without a dedicated font_url -->
+                <link href='https://fonts.googleapis.com/css?family=Lora:400,700%7COpen+Sans:400,300,800,700' rel='stylesheet' type='text/css'>
+            {% endif %}
+        {% endif %}
+
+        <style>
+          :root {
+            {% if locale.font_family != "" %}--font-locale: {{ locale.font_family }};{% endif %}
+            --line-height-locale: {{ locale.line_height }};
+          }
+        </style>
+
+        <link rel="stylesheet" type="text/css" href="{{ 'assets/css/cv-' | append: locale.direction | append: '.css' | relative_url }}">
+
+        {% include hreflang.html %}
+
+        {% seo %}
+
+        {% include analytics-head.html %}
+    </head>
+
+    <body class="theme-{% if site.resume_theme %}{{ site.resume_theme }}{% endif %}">
+        <!-- Accessible skip-to-content link (WCAG 2.4.1) -->
+        <a href="#main-content" class="skip-link no-print">{{ locale.ui.skip_to_content }}</a>
+
+        <!-- Analytics body snippet (noscript, dataLayer, etc.) -->
+        {% include analytics-body.html %}
+
+        <div class="wrapper" itemscope itemtype="https://schema.org/Person">
+            {% include dark-mode-toggle.html %}
+            {% include language-switcher.html %}
+
+            {%- comment -%}
+            Schema.org Microdata & Live Contact Protection:
+            When site.enable_live is true, phone_live and email_live are used for privacy.
+            Fallback to standard phone/email if live versions are not provided.
+            {%- endcomment -%}
+            {% if site.enable_live == true and site.contact_info.phone_live %}
+            <meta itemprop="telephone" content="{{ site.contact_info.phone_live }}" />
+            {% elsif site.contact_info.phone %}
+            <meta itemprop="telephone" content="{{ site.contact_info.phone }}" />
+            {% endif %}
+
+            {% if site.enable_live == true and site.contact_info.email_live %}
+            <meta itemprop="email" content="{{ site.contact_info.email_live }}" />
+            {% elsif site.contact_info.email %}
+            <meta itemprop="email" content="{{ site.contact_info.email }}" />
+            {% endif %}
+
+            {% if lang_cfg.address %}
+            <meta itemprop="address" content="{{ lang_cfg.address }}" />
+            {% endif %}
+
+            <header class="page-header" role="banner">
+
+                {% if site.resume_avatar == true %}
+                    <!-- You can turn off the avatar in _config.yml by setting resume_avatar to false -->
+                    {% include avatar.html lang=lang %}
+                {% endif %}
+
+                <!-- Your name is defined in _config.yml under languages.{{ lang }}.name -->
+                <h1 class="header-name" itemprop="name">
+                    {{ lang_cfg.name }}
+                </h1>
+
+                {%- comment -%}
+                Contact Information Bar (Feature 2.8, icon-first for every direction):
+                Displays contact channels (phone, email, address, date of birth, languages).
+                When site.enable_live is true, sanitized live contact points are rendered.
+                Phone numbers and email addresses are wrapped with dir="ltr" to prevent
+                bidirectional punctuation distortion in RTL locales, and are harmless no-ops in LTR ones.
+                {%- endcomment -%}
+                {% if site.display_header_contact_info == true %}
+                    <!-- To display contact info here, change `display_header_contact_info` value in _config.yml to true -->
+                    <div class="header-contact-info">
+                        <p>
+                            {%- assign contact_phone = site.contact_info.phone -%}
+                            {%- if site.enable_live == true and site.contact_info.phone_live -%}
+                                {%- assign contact_phone = site.contact_info.phone_live -%}
+                            {%- endif -%}
+                            {% if contact_phone %}
+                                {% include vendors/svg-icons/phone.svg %}&nbsp;<a href="tel:{{ contact_phone | remove: ' ' | remove: '-' | remove: '(' | remove: ')' }}" dir="ltr" style="text-decoration: none; color: inherit;">{{ contact_phone }}</a>
+                            {% endif %}
+
+                            {%- assign contact_email_display = site.contact_info.email -%}
+                            {%- if site.enable_live == true and site.contact_info.email_live -%}
+                                {%- assign contact_email_display = site.contact_info.email_live -%}
+                            {%- endif -%}
+                            {% if contact_email_display %}
+                                &nbsp;&nbsp;{% include vendors/svg-icons/envelope.svg %}&nbsp;<a href="mailto:{{ contact_email_display }}" dir="ltr" style="text-decoration: none; color: inherit;">{{ contact_email_display }}</a>
+                            {% endif %}
+
+                            {% if lang_cfg.address %}
+                                &nbsp;&nbsp;{% include vendors/svg-icons/postcard.svg %}&nbsp;{{ lang_cfg.address }}
+                            {% endif %}
+
+                            {% if site.contact_info.dob %}
+                                &nbsp;&nbsp;{{ locale.ui.date_of_birth }}&nbsp;{% include date-formatter.html date=site.contact_info.dob style="MDY" lang=lang %}
+                            {% endif %}
+                        </p>
+
+                        {%- comment -%}
+                        Active Languages Header Summary:
+                        Filters languages where active: true and renders a dedicated centered line,
+                        joined with the locale's list_separator (e.g. Arabic comma "، ").
+                        {%- endcomment -%}
+                        {% assign active_languages = resume_data.languages | where: "active", true %}
+                        {% if site.resume_section.lang_header and active_languages.size > 0 %}
+                            <p class="header-languages">
+                                <strong>{{ locale.ui.languages }}</strong>
+                                {% for language in active_languages %}
+                                    {{ language.language }} ({{ language.descrp_short }}){% unless forloop.last %}{{ locale.ui.list_separator }}{% endunless %}
+                                {% endfor %}
+                            </p>
+                        {% endif %}
+                    </div>
+                {% endif %}
+
+                <div class="title-bar no-print">
+                    <!-- Your title is defined in _config.yml under languages.{{ lang }}.resume_title -->
+                    <h2 class="header-title" itemprop="jobTitle">{{ lang_cfg.resume_title }}</h2>
+
+                    <!-- This is the markup for the icon links; moved out to an include because it's very verbose, and you shouldn't ever need to edit the markup (unless you want to re-order the icons); if you want to customize which links appear, define them in the _config.yml file -->
+                    {% if site.social_links %}
+                    <!-- and guess where these are defined? Yup, you guessed it: the _config.yml file -->
+                        <ul class="social-links">
+                            {% include social-links.html %}
+                        </ul>
+                    {% endif %}
+                </div>
+
+                {% if lang_cfg.header_intro == true %}
+                <div class="executive-summary" itemprop="description">
+                    <p>{{ resume_data.header.intro }}</p>
+                </div>
+                {% endif %}
+
+                {%- comment -%}
+                Job Seeking / Availability Call-to-Action:
+                - true: Displays localized "Contact me" mailto CTA.
+                - false: Displays localized "I'm not looking for work" badge.
+                - nil: Hidden entirely.
+                {%- endcomment -%}
+                {% if site.resume_looking_for_work == true %}
+                    {% assign contact_email = site.contact_info.email %}
+                    {% if site.enable_live == true and site.contact_info.email_live %}
+                        {% assign contact_email = site.contact_info.email_live %}
+                    {% endif %}
+                    <a href="mailto:{{ contact_email }}" class="contact-button no-print" itemprop="email">{{ locale.ui.contact_me }}</a>
+                {% elsif site.resume_looking_for_work == false %}
+                    <a class="contact-button not-looking no-print">{{ locale.ui.not_looking_for_work }}</a>
+                {% else %}
+                {% endif %}
+            </header>
+
+            <!-- Main resume content landmark (WCAG 1.3.1 / 2.4.1) -->
+            <main id="main-content" class="resume-main-content" role="main" tabindex="-1">
+                {% comment %}
+                =============================================================================
+                  DYNAMIC SECTION RENDERING
+                =============================================================================
+                  Loop through resume_section_order from _config.yml and render each section
+                  through the locale-driven dispatcher. This allows you to customize section
+                  order without editing the layout.
+                {% endcomment %}
+                {%- for section_name in site.resume_section_order -%}
+                    {% include resume-section.html section_name=section_name lang=lang %}
+                {%- endfor -%}
+
+                {% if site.resume_print_social_links %}
+                    <!-- begin Print Social Links -->
+                    <section class="content-section print-only">
+
+                        <header class="section-header">
+                            <h2>{{ locale.ui.social_links }}</h2>
+                        </header>
+
+                        <div class="resume-item">
+                            {% include print-social-links.html %}
+                        </div>
+
+                    </section>
+                    <!-- end Print Social Links -->
+                {% endif %}
+            </main>
+
+            <footer class="page-footer no-print" role="contentinfo">
+                <p class="footer-line">
+                    {{ locale.ui.page_last_generated_on }} {{ "now" | date: "%Y-%m-%d" }} {{ locale.ui.at }} {{ "now" | date: "%H:%M:%S" }}Z.
+                </p>
+                <p class="copyright">{{ site.title }} &copy; 2018 - {{ "now" | date: "%Y" }}</p>
+            </footer>
+
+            {%- comment -%}
+            Print-Only Footer:
+            When site.enable_live == false, appends the canonical permalink of the online resume
+            to printed versions/PDF exports for offline verification.
+            {%- endcomment -%}
+            {% if site.enable_live == false %}
+                <footer class="page-footer print-only" role="contentinfo">
+                    <p class="footer-line">
+                        {{ locale.ui.cv_last_generated_on }} {{ "now" | date: "%Y-%m-%d" }} {{ locale.ui.at }} {{ "now" | date: "%H:%M:%S" }}Z.
+                        <br>
+                        <a href="{{ page.url | replace:'index.html','' | prepend: site.baseurl | prepend: site.url }}" target="_blank" rel="noopener noreferrer" style="font-weight: 100; color: #999;">
+                            {{ page.url | replace:'index.html','' | prepend: site.baseurl | prepend: site.url }}
+                        </a>
+                    </p>
+                </footer>
+            {% endif %}
+        </div>
+
+    </body>
+</html>

data/_plugins/error_pages_generator.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module JekyllThemeResume
+  # Programmatically synthesizes standard HTTP error pages (404, 403, 500)
+  # into site.pages if they are not already defined by the site.
+  #
+  # WHY THIS IS NECESSARY:
+  # Jekyll gem-based themes only distribute assets, _layouts, _includes, _sass,
+  # and _data. Root-level HTML files in a gem theme are NOT automatically copied
+  # or rendered into the consuming site's destination directory (_site/).
+  #
+  # HOW IT WORKS:
+  # This generator executes during the Jekyll build pipeline. For each error page
+  # defined in ERROR_PAGES, it checks whether the consuming site already provides
+  # an override. If no override exists, it creates an in-memory virtual page
+  # (Jekyll::PageWithoutAFile) and adds it to site.pages so Jekyll compiles it
+  # using _layouts/error.html.
+  class ErrorPagesGenerator < Jekyll::Generator
+    # safe true: Allows plugin execution in Jekyll safe mode / GitHub Pages environments
+    safe true
+    # priority :low: Ensures all physical pages in the consuming site are parsed and
+    # added to site.pages first, allowing our collision checks to be fully accurate.
+    priority :low
+
+    # Standard HTTP error codes, target output filenames, and default bilingual titles.
+    ERROR_PAGES = {
+      "404" => {
+        "file" => "404.html",
+        "title" => "404 - Page Not Found"
+      },
+      "403" => {
+        "file" => "403.html",
+        "title" => "403 - Access Forbidden"
+      },
+      "500" => {
+        "file" => "500.html",
+        "title" => "500 - Internal Server Error"
+      }
+    }.freeze
+
+    def generate(site)
+      ERROR_PAGES.each do |code, info|
+        filename = info["file"]
+        # Skip if page already exists in site.pages or in site source files
+        #
+        # THREE-TIER COLLISION PREVENTION:
+        # 1. Check in-memory site.pages for existing page name or permalink URL
+        next if site.pages.any? { |p| p.name == filename || p.url == "/#{filename}" }
+        # 2. Check if a physical file exists at the root of the consuming site
+        next if File.exist?(site.in_source_dir(filename))
+        # 3. Check if a physical file exists in the _pages/ collection directory
+        next if File.exist?(site.in_source_dir("_pages", filename))
+
+        # Synthesize virtual page in memory without requiring a physical file on disk.
+        # Arguments: site, base directory, sub-directory (""), file name
+        page = Jekyll::PageWithoutAFile.new(site, site.source, "", filename)
+        page.content = ""
+        # Assign Front Matter metadata consumed by _layouts/error.html:
+        page.data["layout"] = "error"
+        page.data["code"] = code
+        page.data["title"] = info["title"]
+        page.data["permalink"] = "/#{filename}"
+        # Exclude synthetic error pages from sitemap generators (e.g. jekyll-sitemap)
+        page.data["sitemap"] = false
+
+        # Append virtual page to site.pages so Jekyll renders and writes it to _site/
+        site.pages << page
+      end
+    end
+  end
+end

data/_plugins/json_resume_generator.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+require_relative "../lib/jekyll-theme-resume/json_resume_exporter"
+require_relative "../lib/jekyll-theme-resume/resume_validator"
+
+module JekyllThemeResume
+  class JsonResumePage < Jekyll::PageWithoutAFile
+    def initialize(site, route, document)
+      super(site, site.source, File.dirname(route).delete_prefix("/"), "resume.json")
+      self.content = "#{JSON.pretty_generate(document)}\n"
+      data.merge!("layout" => nil, "permalink" => route, "sitemap" => false)
+    end
+
+    # Jekyll::Site uses Renderer directly, not Page#render.
+    def render_with_liquid?
+      false
+    end
+
+    def place_in_layout?
+      false
+    end
+  end
+
+  class JsonResumeGenerator < Jekyll::Generator
+    safe true
+    priority :lowest
+
+    def generate(site)
+      site.config["json_resume_routes"] = {}
+      options = site.config["json_resume"].is_a?(Hash) ? site.config["json_resume"] : {}
+      languages = site.config["languages"]
+      return if options["enabled"] == false || !languages.is_a?(Hash)
+
+      selected_languages(languages, options).each do |lang|
+        unless ResumeValidator::LANG_KEY_REGEX.match?(lang.to_s)
+          Jekyll.logger.warn "JSON Resume:", "invalid language route; skipping export"
+          next
+        end
+        route = "/#{lang}/resume.json"
+        next if collision?(site, route)
+
+        document = JsonResumeExporter.export(site, lang)
+        next unless document
+
+        site.pages << JsonResumePage.new(site, route, document)
+        site.config["json_resume_routes"][lang] = route
+        next unless lang == (site.config["default_lang"] || "en") && options["root_export"] != false
+        next if collision?(site, "/resume.json")
+
+        site.pages << JsonResumePage.new(site, "/resume.json", document)
+      end
+    end
+
+    private
+
+    def selected_languages(languages, options)
+      requested = options["languages"]
+      return languages.keys if requested.nil? || requested == []
+
+      unless requested.is_a?(Array)
+        Jekyll.logger.warn "JSON Resume:", "languages must be an array; skipping exports"
+        return []
+      end
+      requested.uniq.select do |lang|
+        known = languages.key?(lang)
+        Jekyll.logger.warn "JSON Resume:", "unknown export language '#{lang}'; ignored" unless known
+        known
+      end
+    end
+
+    def collision?(site, route)
+      target = File.expand_path(route.delete_prefix("/"), site.dest)
+      resources = site.pages + site.static_files + site.collections.values.flat_map(&:docs)
+      occupied = resources.any? { |item| File.expand_path(item.destination(site.dest)) == target }
+      Jekyll.logger.warn "JSON Resume:", "#{route}: destination occupied; keeping existing resource" if occupied
+      occupied
+    end
+  end
+end

data/_plugins/resume_pages_generator.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require_relative "../lib/jekyll-theme-resume/resume_validator"
+
+module JekyllThemeResume
+  # Synthesizes a CV (layout: resume) and profile (layout: profile) page for every
+  # languages.<lang> entry in _config.yml that doesn't already have a hand-authored one,
+  # the same way ErrorPagesGenerator synthesizes 404/403/500 pages (see
+  # error_pages_generator.rb). t_id matches the documented convention (t_id: resume /
+  # t_id: profile) so hreflang.html and language-switcher.html match generated and
+  # hand-authored pages identically.
+  class ResumePagesGenerator < Jekyll::Generator
+    safe true
+    # priority :low: run after physical pages are parsed, so collision checks are accurate.
+    priority :low
+
+    def generate(site)
+      languages = site.config["languages"]
+      return unless languages.is_a?(Hash)
+
+      default_lang = site.config["default_lang"] || "en"
+
+      languages.each do |lang, lang_cfg|
+        unless ResumeValidator::LANG_KEY_REGEX.match?(lang.to_s)
+          Jekyll.logger.warn "ResumePagesGenerator:",
+                             "skipping language #{lang.to_s.inspect}: keys may only use letters, digits, '-' and '_'."
+          next
+        end
+
+        lang_cfg ||= {}
+        synthesize_or_warn(site, "resume", lang, lang_cfg["url"], lang_cfg)
+
+        profile_url = lang == default_lang ? "/" : "/#{lang}/"
+        synthesize_or_warn(site, "profile", lang, profile_url, lang_cfg)
+      end
+    end
+
+    private
+
+    def synthesize_or_warn(site, layout, lang, permalink, lang_cfg)
+      return if existing_page?(site, layout, lang, permalink)
+
+      unless permalink && auto_generate?(site, lang_cfg)
+        Jekyll.logger.warn "ResumePagesGenerator:",
+                           "no #{layout} page for language '#{lang}' - auto-generation is " \
+                           "disabled or languages.#{lang}.url is missing, and no " \
+                           "hand-authored page exists. This language will not be built."
+        return
+      end
+
+      page = Jekyll::PageWithoutAFile.new(site, site.source, "", "#{layout}-#{lang}.html")
+      page.content = ""
+      page.data["layout"] = layout
+      page.data["lang"] = lang
+      page.data["t_id"] = layout
+      page.data["permalink"] = permalink
+      site.pages << page
+    end
+
+    def existing_page?(site, layout, lang, permalink)
+      site.pages.any? { |p| p.data["layout"] == layout && p.data["lang"] == lang } ||
+        (permalink && site.pages.any? { |p| p.url == permalink })
+    end
+
+    def auto_generate?(site, lang_cfg)
+      return lang_cfg["auto_generate_pages"] unless lang_cfg["auto_generate_pages"].nil?
+
+      site.config["resume_auto_generate_pages"] != false
+    end
+  end
+end

data/_plugins/resume_validator.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require_relative "../lib/jekyll-theme-resume/resume_validator"
+
+module JekyllThemeResume
+  # Jekyll Generator that validates resume YAML data during Jekyll build (on by default).
+  #
+  # _config.yml switches:
+  #   validate_resume: false        # Opt out of validation entirely
+  #   validate_resume_strict: true  # Abort the build on validation errors
+  class ResumeValidatorGenerator < Jekyll::Generator
+    safe true
+    priority :low
+
+    def generate(site)
+      return if site.config["validate_resume"] == false
+
+      data_dir = site.config["data_dir"] || "_data"
+      full_data_path = site.in_source_dir(data_dir)
+
+      # Check if the data directory or language subdirectories exist
+      unless Dir.exist?(full_data_path)
+        Jekyll.logger.warn("ResumeValidator:", "Configured data directory '#{full_data_path}' not found. Skipping.")
+        return
+      end
+
+      # Hand over the already-parsed config so languages come from `languages:` without re-reading disk.
+      validator = ResumeValidator.new(full_data_path, config: site.config)
+      strict = site.config["validate_resume_strict"] == true
+      fail_warnings = site.config["validate_resume_fail_on_warnings"] == true
+      validator.validate(fail_on_warnings: fail_warnings)
+
+      return unless strict && (validator.errors.any? || (fail_warnings && validator.warnings.any?))
+
+      msg = "Resume validation failed with #{validator.errors.size} error(s)"
+      msg += " and #{validator.warnings.size} warning(s)" if fail_warnings
+      raise Jekyll::Errors::FatalException, "#{msg} in strict mode."
+    end
+  end
+end