Skip to content

feat: add json cv page and related scripts #2901

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 16, 2025

Conversation

chenyuan99
Copy link
Contributor

@chenyuan99 chenyuan99 commented Mar 13, 2025

Features Added Implement #2883

  1. CV Markdown to JSON Converter

    • Python script (scripts/cv_markdown_to_json.py) that converts markdown CV to structured JSON
    • Automatically extracts information from your existing CV markdown file
    • Integrates with your site's configuration to pull author information
    • Pulls in publications, talks, teaching, and portfolio entries from your existing content
  2. JSON CV Display Page

    • New layout template (_layouts/cv-layout.html) for displaying the JSON CV
    • Custom CSS styling (assets/css/cv-layout.css) for a professional appearance
    • Navigation link to the JSON CV page
  3. Automated Update Script

    • Shell script (scripts/update_cv_json.sh) to easily update your CV JSON when you modify your markdown CV
    • Automatically rebuilds the site to show your changes (optional)

How to Use

  1. Update Your CV

    • Edit your existing markdown CV at _pages/cv.md as usual
    • Run the update script: bash scripts/update_cv_json.sh
    • Your CV will be converted to JSON format and saved to _data/cv.json
  2. View Your JSON CV

    • Navigate to the "JSON CV" link in your site's header
    • The CV is displayed in a clean, professional format
    • Information is automatically organized into sections for education, work experience, skills, publications, etc.
  3. Customize the Layout

    • Modify assets/css/cv-layout.css to adjust the styling
    • Edit _layouts/cv-layout.html to change the structure

Benefits

  • Maintains a single source of truth (your markdown CV)
  • Provides a more structured, professional CV display option
  • Automatically integrates with your existing academicpages content
  • Makes your CV data available in a structured format for other uses

This feature enhances the academicpages template by providing a more modern way to display your CV while maintaining compatibility with the existing markdown-based CV.

@rjzupkoii
Copy link
Collaborator

Thanks for the PR! Can you update the with a bit of documentation of what has been added like #2900?

@chenyuan99 chenyuan99 changed the title feat: add json csv page and related scripts feat: add json cv page and related scripts Mar 15, 2025
@rjzupkoii
Copy link
Collaborator

Thanks for the pull request and hard work to get this running!

@rjzupkoii rjzupkoii merged commit ec68bcf into academicpages:master Mar 16, 2025
@chenyuan99 chenyuan99 deleted the parent-feature-#2883 branch March 16, 2025 21:27
georgiagracetully pushed a commit to georgiagracetully/georgiagracetully.github.io that referenced this pull request May 1, 2025
…#2883

feat: add json cv page and related scripts
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants