Skip to content

shmVirus/hugo-theme-a4resume

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

A print-first A4 resume/CV Hugo theme for academics, researchers, and software engineers.
Publish it as a web resume or export a PDF directly from the browser.

Live Demo · Wiki

Features

  • A4 print layout — A4 sizing for browser viewing, printing, and PDF export
  • Auto-pagination — splits content into A4 pages with optional page numbers
  • Built-in sections — Experience, Education, Skills, Publications, Projects, Awards, and more; see Section List
  • Custom sections — add a data/<section>.yaml and register it in config.yaml
  • Per-section controls — order, title, visibility, icon, and page-break hint
  • Per-field controls — experience, education, projects, publications, and languages
  • Publications — standard/IEEE/compact citation styles, author links, DOI/PDF/code, and venue metrics
  • Icons — Font Awesome or inline SVG, per section and per entry
  • Footer — auto last-updated date and custom footnote

See the Wiki for full configuration reference.

Requirements

Hugo v0.154.0+ extended. Check with hugo version; if not installed, follow the official guide.

Usage

Method 1 — New Hugo site

Add the theme to a new or existing Hugo site — submodule for easy future updates, clone for simplicity.

  1. Create a new Hugo site:

    hugo new site resume --format yaml && cd resume
    git init
  2. Add the theme:

    Option A — Submodule (pull future updates with git submodule update --remote):

    git submodule add git@github.com:shmVirus/hugo-theme-a4resume.git themes/a4resume

    Option B — Clone (simpler; updates require a manual git pull inside the theme folder):

    git clone git@github.com:shmVirus/hugo-theme-a4resume.git themes/a4resume
  3. Copy the example config, data, and deploy workflow:

    cp themes/a4resume/exampleSite/config.yaml .
    cp -r themes/a4resume/exampleSite/data .
    mkdir -p .github/workflows
    cp themes/a4resume/.github/workflows/deploy.yml .github/workflows/
  4. Edit config.yaml and set your baseURL, title, and theme params to your preferences.

  5. Open the data/ files and replace the example content with your own.

  6. Start the development server:

    hugo server
  7. Open the live preview URL from the terminal, and update config.yaml and data/ if necessary.

  8. Deploy to your preferred static host:

    • Option A — GitHub Pages: enable Pages (source: GitHub Actions) in repository settings and push
    • Option B — Netlify: connect repo, set build command to hugo
    • Option C — Vercel: connect repo, set framework to Hugo
    • Option D — Cloudflare Pages: connect repo, set build command to hugo

Method 2 — GitHub template

The quickest path to a live GitHub Pages resume — no local Hugo setup needed.

  1. Click Use this template on GitHub to create your own repository.
  2. Edit exampleSite/config.yaml and set your baseURL, title, and theme params.
  3. Edit the exampleSite/data/ files with your own information.
  4. Push to main — GitHub Actions builds and deploys your resume automatically.

Contributing

Issues and pull requests are welcome. For major changes, please open an issue first for discussion.

Credits

Inspired by resume-a4 by Mert Bakir.

License

MIT

Contributors