New Language

Register Your Language

To add a new layout.locale.language option to YAMLResume, first register your language in models/resume.ts by adding a new entry to LOCALE_LANGUAGE_OPTIONS.

Checklist:

• Add your language to LOCALE_LANGUAGE_OPTIONS.
• Build and test the new CLI with pnpm cli dev languages list, making sure your language appears in the list.

Add Translations

Provide translations for all relevant options, punctuations and terms used in YAMLResume. This ensures users can generate resumes in the new language with accurate labels, options, terms translations, and section names. Here is a reference PR for adding translations for the Norwegian language.

Checklist:

• Add translations to country names
• Add option translations for degrees, fluency, languages, sections, and skills
• Add punctuation translations for comma, colon, and separator
• Add terms translations for courses, keywords, and score

Update Babel Configuration

YAMLResume uses LaTeX for PDF generation, and to get best typesetting results, we need to set proper babel package configuration. Here is a reference commit for norwegian language.

Checklist:

• Update renderBabelConfig() function in preamble.ts to include the babel package for your new language.

Test with New Language

Build yamlresume/core and yamlresume/cli packages, then:

• Create a new resume pnpm cli dev new my-resume.yml
• Set layout.locale.language to the new language you've just added
• Test your changes by generating a resume in the new language by pnpm cli dev build my-resume.yml
• Make sure both PDF outputs work as expected.

Submitting Your PR

Once you have completed the above steps, submit your pull request with a clear description of the changes and the language you are adding. The maintainers will review your PR and may request changes or clarifications.