Skip to content

opensource4you/markdown-resume-builder

Repository files navigation

Quarto Resume

A clean, single-source resume template built with Quarto. Write in Markdown, generate perfectly styled PDF (via LaTeX/Lua) and HTML.

Below is a preview of the generated resume. You can also view the Source File or the Full PDF.


🚀 快速開始:透過 Issue 自動渲染 (無需安裝)

如果你不想在本地安裝 Quarto 或 LaTeX,可以直接利用本專案的自動化流程:

  1. 準備內容:將你的履歷內容(Markdown/Quarto)上傳至 GitHub Gist
  2. 獲取連結:在 Gist 頁面點擊 "Raw" 並複製該網域為 gist.githubusercontent.com 的網址。
  3. 提交 Issue:前往 建立履歷 Issue,貼上連結並送出。
  4. 獲取 PDF:稍等約 1 分鐘,機器人會回覆處理進度。請點擊留言中的連結前往 Action Summary 頁面下載產出的 PDF。

💡 小技巧: 若需更新履歷內容,只需直接 編輯 (Edit) 該 Issue 的內容並儲存,系統就會自動偵測變更並重新渲染最新的版本,無需重複開啟 Issue。


preview

Prerequisites

To use this template, you need to have Quarto and a LaTeX distribution installed.

1. Install Quarto

Download and install the latest version from: quarto.org/docs/get-started/

2. Install TinyTeX

Quarto uses TinyTeX for PDF rendering. Run this command to install it:

quarto install tinytex

Structure

The resume has three main sections:

  1. Title Block - Name and contact information (links, email, phone)
  2. Summary - Bullet points highlighting key qualifications
  3. Detail Blocks - Experience sections with:
    • Title (e.g., position/role)
    • Date (right-aligned)
    • Subtitle/Location (metadata)
    • Bullet points describing responsibilities/achievements

Usage

Method 1: Use as a Quarto Template (Recommended)

You can initialize a new project using this template directly via the Quarto CLI. This is the cleanest way to start a new resume:

quarto use template machichima/quarto-resume-template

Note: To make quarto use template work seamlessly, ensure you have a template.qmd in your root directory (or the directory you specify). Quarto will look for this file to scaffold the user's new project.

Method 2: Fork and Modify

  1. Fork this repository.
  2. Clone it to your local machine.
  3. Edit resume.qmd with your information.

Workflow

Note: The HTML format is currently experimental. It is highly recommended to preview and render using the PDF format for the best layout results.

Preview

To see changes in real-time while you edit:

quarto preview resume.qmd --to pdf

Render to PDF

To generate the final version:

quarto render resume.qmd --to pdf

Syntax Guide

This template uses specific classes to trigger layout logic for PDF and HTML.

1. Header & Contact

Use following for the name (title) and contact details.

::: {.resume-header .center}
# Your Name
:::

::: {.center data-latex=""}
email@example.com | [Link](...) | [Link](...)
:::

2. Experience/Project Blocks

Strict Format Required: Use {.experience-block} on the header, followed immediately by a {.metadata} div containing {.date}, {.subtitle}, and {.location} spans.

### Job/Project Title {.experience-block}

::: {.metadata}
[Date Range]{.date}

[Company / Subtitle]{.subtitle}

[Location]{.location}
:::

- Bullet point
  - Sub-bullet

Configuration Files

File Purpose
resume.qmd Main content (Markdown) and basic PDF/HTML options (margins, fonts).
resume-header.tex LaTeX Styling. Handles headers, bullet points, spacing, and font styles for the PDF.
resume-filter.lua PDF Layout. A script that automatically aligns dates to the right and titles to the left.
styles.css HTML Layout. Handles the Web version layout using CSS Flexbox.

Customization

  • Fonts & Margins: Edit fontsize and geometry in the YAML header of resume.qmd.
  • Bullet Points: Modify \setlist[itemize] in resume-header.tex to change symbols or indentation.
  • Spacing & Headers: Adjust \titlespacing and \titleformat in resume-header.tex to change the gaps between sections or the look of section titles.
  • HTML Styling: Edit styles.css to change how the web version looks.

About

Building your resume with markdown!

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors 2

  •  
  •