YAMLResume

HTML Engine

The HTML engine generates clean, web-ready HTML versions of your resume. This is particularly useful for embedding your resume on websites, sharing it online, or creating a web-based portfolio.

Configuration

To use the HTML engine, specify engine: html in your layout configuration.

layouts:
  - engine: html
    template: calm
    # ... other options

Sections

The sections option allows you to customize the section titles and their order. For more information, see the sections documentation.

layouts:
  - engine: html
    sections:
      aliases:
        work: "Professional Experience"
        education: "Education"
        skills: "Skills"
      order:
        - basics
        - work
        - education

Templates

The template option allows you to choose from a variety of templates. Each template has a unique design and layout. You can find a list of available templates in the templates documentation.

layouts:
  - engine: html
    template: calm

Typography

The typography option allows you to customize font styles used in your resume.

Font Size

The fontSize option allows you to set the base font size for the document. The HTML engine supports font sizes from 14px to 20px.

Font Family

The fontFamily option allows you to specify a prioritized list of font family names and/or generic family names. This works exactly like the CSS font-family property.

layouts:
  - engine: html
    typography:
      fontSize: 16px
      fontFamily: "Merriweather, serif"

Advanced

The advanced option allows you to configure advanced settings for the HTML engine.

layouts:
  - engine: html
    advanced:
      showIcons: true
      # Custom title for the HTML document.
      title: "My Custom Resume Title"
      # Custom footer for the HTML document.
      footer: "Generated by <a href=\"https://yamlresume.dev\">YAMLResume</a>"
      # Meta description for the HTML document.
      description: "A brief description of the resume for SEO."
      # Meta keywords for the HTML document.
      keywords: "resume, cv, yamlresume"
Edit on GitHub

Last updated on