{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "content": { "type": "object", "properties": { "basics": { "type": "object", "properties": { "name": { "type": "string", "minLength": 2, "maxLength": 128, "title": "Name", "description": "Your personal name.", "examples": [ "Andy Dufresne", "Xiao Hanyu", "Jane Smith", "Dr. Robert John" ] }, "email": { "title": "[optional] Email", "description": "A valid email address or `null`.", "examples": [ "hi@ppresume.com", "first.last@company.org", "test+tag@domain.co.uk" ], "anyOf": [ { "title": "[optional] Email", "description": "A valid email address or `null`.", "$ref": "#/$defs/email" }, { "type": "null" } ] }, "headline": { "title": "[optional] Headline", "description": "A short and catchy headline for your resume or `null`.", "examples": [ "Full-stack software engineer", "Data Scientist with a passion for Machine Learning", "Product Manager driving innovation" ], "anyOf": [ { "type": "string", "minLength": 2, "maxLength": 128, "title": "[optional] Headline", "description": "A short and catchy headline for your resume or `null`.", "examples": [ "Full-stack software engineer", "Data Scientist with a passion for Machine Learning", "Product Manager driving innovation" ] }, { "type": "null" } ] }, "phone": { "title": "[optional] Phone", "description": "A valid phone number that may include country code, parentheses, spaces, and hyphens or `null`.", "examples": [ "555-123-4567", "+44 20 7946 0958", "(555) 123-4567" ], "anyOf": [ { "title": "[optional] Phone", "description": "A valid phone number that may include country code, parentheses, spaces, and hyphens or `null`.", "$ref": "#/$defs/phone" }, { "type": "null" } ] }, "summary": { "title": "[optional] Summary", "description": "A summary text between 16 and 1024 characters or `null`.", "examples": [ "Experienced software engineer with 5+ years in full-stack development.", "Creative designer passionate about user experience and modern design principles.", "Dedicated project manager with proven track record of delivering complex projects on time and budget." ], "anyOf": [ { "title": "[optional] Summary", "description": "A summary text between 16 and 1024 characters or `null`.", "$ref": "#/$defs/summary" }, { "type": "null" } ] }, "url": { "title": "[optional] URL", "description": "A valid URL with maximum length of 256 characters or `null`.", "examples": [ "https://yamlresume.dev", "https://ppresume.com", "https://github.com/yamlresume/yamlresume", "https://linkedin.com/in/xiaohanyu1988", "https://www.example.com" ], "anyOf": [ { "title": "[optional] URL", "description": "A valid URL with maximum length of 256 characters or `null`.", "$ref": "#/$defs/url" }, { "type": "null" } ] } }, "required": [ "name" ], "additionalProperties": false, "title": "Basics", "description": "The basics section contains your personal information, such as your name, email, phone number, and a brief summary." }, "education": { "type": "array", "items": { "type": "object", "properties": { "area": { "type": "string", "minLength": 2, "maxLength": 64, "title": "Area", "description": "Your field of study or major.", "examples": [ "Computer Science", "Business Administration", "Engineering", "Arts" ] }, "institution": { "type": "string", "minLength": 2, "maxLength": 128, "title": "Institution", "description": "The institution that awarded the degree.", "examples": [ "University of California, Los Angeles", "Harvard University", "Zhejiang University" ] }, "degree": { "type": "string", "enum": [ "Middle School", "High School", "Diploma", "Associate", "Bachelor", "Master", "Doctor" ], "title": "Degree option", "description": "A predefined option from the available degree choices." }, "startDate": { "type": "string", "minLength": 4, "maxLength": 32, "title": "Start date", "description": "A valid date string that can be parsed by `Date.parse`.", "examples": [ "2025", "2025-01-01", "Jul 2025", "July 3, 2025", "2025-02-02T00:00:03.123Z" ] }, "courses": { "title": "[optional] Courses", "description": "A list of relevant courses you have taken or `null`.", "examples": [ [ "Data Structures", "Algorithms", "Database Systems" ], [ "Marketing", "Finance", "Operations Management" ], [ "Calculus", "Physics", "Chemistry" ] ], "anyOf": [ { "type": "array", "items": { "type": "string", "minLength": 2, "maxLength": 128 }, "title": "[optional] Courses", "description": "A list of relevant courses you have taken or `null`.", "examples": [ [ "Data Structures", "Algorithms", "Database Systems" ], [ "Marketing", "Finance", "Operations Management" ], [ "Calculus", "Physics", "Chemistry" ] ] }, { "type": "null" } ] }, "endDate": { "title": "[optional] End date", "description": "A valid date string that can be parsed by `Date.parse` or `null`.", "examples": [ "2025", "2025-01-01", "Jul 2025", "July 3, 2025", "2025-02-02T00:00:03.123Z" ], "anyOf": [ { "type": "string", "minLength": 4, "maxLength": 32, "title": "[optional] End date", "description": "A valid date string that can be parsed by `Date.parse` or `null`.", "examples": [ "2025", "2025-01-01", "Jul 2025", "July 3, 2025", "2025-02-02T00:00:03.123Z" ] }, { "type": "null" } ] }, "summary": { "title": "[optional] Summary", "description": "A summary text between 16 and 1024 characters or `null`.", "examples": [ "Experienced software engineer with 5+ years in full-stack development.", "Creative designer passionate about user experience and modern design principles.", "Dedicated project manager with proven track record of delivering complex projects on time and budget." ], "anyOf": [ { "title": "[optional] Summary", "description": "A summary text between 16 and 1024 characters or `null`.", "$ref": "#/$defs/summary" }, { "type": "null" } ] }, "score": { "title": "[optional] Score", "description": "Your GPA, grade, or other academic score or `null`.", "examples": [ "3.8", "3.8/4.0", "A+", "95%", "First Class Honours" ], "anyOf": [ { "type": "string", "minLength": 2, "maxLength": 32, "title": "[optional] Score", "description": "Your GPA, grade, or other academic score or `null`.", "examples": [ "3.8", "3.8/4.0", "A+", "95%", "First Class Honours" ] }, { "type": "null" } ] }, "url": { "title": "[optional] URL", "description": "A valid URL with maximum length of 256 characters or `null`.", "examples": [ "https://yamlresume.dev", "https://ppresume.com", "https://github.com/yamlresume/yamlresume", "https://linkedin.com/in/xiaohanyu1988", "https://www.example.com" ], "anyOf": [ { "title": "[optional] URL", "description": "A valid URL with maximum length of 256 characters or `null`.", "$ref": "#/$defs/url" }, { "type": "null" } ] } }, "required": [ "area", "institution", "degree", "startDate" ], "additionalProperties": false }, "title": "Education", "description": "The education section contains your academic background, including degrees, institutions, and relevant coursework." }, "awards": { "title": "Awards", "description": "The awards section contains your achievements and recognitions, including awards, honors, and special acknowledgments.", "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "awarder": { "type": "string", "minLength": 2, "maxLength": 128, "title": "Awarder", "description": "The organization or institution that presented the award.", "examples": [ "Academy Awards", "Tech Conference", "Microsoft Scholarship" ] }, "title": { "type": "string", "minLength": 2, "maxLength": 128, "title": "Title", "description": "The title of the award.", "examples": [ "Dean's List", "Outstanding Student", "Best Supporting Engineer" ] }, "date": { "title": "[optional] Date", "description": "A valid date string that can be parsed by `Date.parse` or `null`.", "examples": [ "2025", "2025-01-01", "Jul 2025", "July 3, 2025", "2025-02-02T00:00:03.123Z" ], "anyOf": [ { "type": "string", "minLength": 4, "maxLength": 32, "title": "[optional] Date", "description": "A valid date string that can be parsed by `Date.parse` or `null`.", "examples": [ "2025", "2025-01-01", "Jul 2025", "July 3, 2025", "2025-02-02T00:00:03.123Z" ] }, { "type": "null" } ] }, "summary": { "title": "[optional] Summary", "description": "A summary text between 16 and 1024 characters or `null`.", "examples": [ "Experienced software engineer with 5+ years in full-stack development.", "Creative designer passionate about user experience and modern design principles.", "Dedicated project manager with proven track record of delivering complex projects on time and budget." ], "anyOf": [ { "title": "[optional] Summary", "description": "A summary text between 16 and 1024 characters or `null`.", "$ref": "#/$defs/summary" }, { "type": "null" } ] } }, "required": [ "awarder", "title" ], "additionalProperties": false } }, { "type": "null" } ] }, "certificates": { "title": "Certificates", "description": "The certificates section contains your professional certifications, including training programs and industry-recognized credentials.", "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "issuer": { "type": "string", "minLength": 2, "maxLength": 128, "title": "Issuer", "description": "The organization that issued the certificate.", "examples": [ "AWS", "Microsoft", "Coursera", "Google Cloud" ] }, "name": { "type": "string", "minLength": 2, "maxLength": 128, "title": "Name", "description": "The name of the certificate.", "examples": [ "Andy Dufresne", "Xiao Hanyu", "Jane Smith", "Dr. Robert John" ] }, "date": { "title": "[optional] Date", "description": "A valid date string that can be parsed by `Date.parse` or `null`.", "examples": [ "2025", "2025-01-01", "Jul 2025", "July 3, 2025", "2025-02-02T00:00:03.123Z" ], "anyOf": [ { "type": "string", "minLength": 4, "maxLength": 32, "title": "[optional] Date", "description": "A valid date string that can be parsed by `Date.parse` or `null`.", "examples": [ "2025", "2025-01-01", "Jul 2025", "July 3, 2025", "2025-02-02T00:00:03.123Z" ] }, { "type": "null" } ] }, "url": { "title": "[optional] URL", "description": "A valid URL with maximum length of 256 characters or `null`.", "examples": [ "https://yamlresume.dev", "https://ppresume.com", "https://github.com/yamlresume/yamlresume", "https://linkedin.com/in/xiaohanyu1988", "https://www.example.com" ], "anyOf": [ { "title": "[optional] URL", "description": "A valid URL with maximum length of 256 characters or `null`.", "$ref": "#/$defs/url" }, { "type": "null" } ] } }, "required": [ "issuer", "name" ], "additionalProperties": false } }, { "type": "null" } ] }, "interests": { "title": "Interests", "description": "The interests section contains your personal interests and hobbies, including activities and topics you are passionate about.", "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "minLength": 2, "maxLength": 128, "title": "Name", "description": "The name of the interest.", "examples": [ "Andy Dufresne", "Xiao Hanyu", "Jane Smith", "Dr. Robert John" ] }, "keywords": { "title": "[optional] Keywords", "description": "An array of keyword, each between 1 and 32 characters or `null`.", "examples": [ [ "Javascript", "React", "Typescript" ], [ "Design", "UI", "UX" ], [ "Python", "Data Science" ] ], "anyOf": [ { "title": "[optional] Keywords", "description": "An array of keyword, each between 1 and 32 characters or `null`.", "$ref": "#/$defs/keywords" }, { "type": "null" } ] } }, "required": [ "name" ], "additionalProperties": false } }, { "type": "null" } ] }, "languages": { "title": "Languages", "description": "The languages section contains your language proficiencies, including fluency levels and related skills.", "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "fluency": { "type": "string", "enum": [ "Elementary Proficiency", "Limited Working Proficiency", "Minimum Professional Proficiency", "Full Professional Proficiency", "Native or Bilingual Proficiency" ], "title": "Fluency option", "description": "A predefined option from the available fluency choices." }, "language": { "type": "string", "enum": [ "Afrikaans", "Albanian", "Amharic", "Arabic", "Azerbaijani", "Belarusian", "Bengali", "Bhojpuri", "Bulgarian", "Burmese", "Cantonese", "Catalan", "Chinese", "Croatian", "Czech", "Danish", "Dutch", "English", "Estonian", "Farsi", "Filipino", "Finnish", "French", "German", "Greek", "Gujarati", "Hausa", "Hebrew", "Hindi", "Hungarian", "Icelandic", "Igbo", "Indonesian", "Irish", "Italian", "Japanese", "Javanese", "Kazakh", "Khmer", "Korean", "Lahnda", "Latvian", "Lithuanian", "Malay", "Mandarin", "Marathi", "Nepali", "Norwegian", "Oromo", "Pashto", "Polish", "Portuguese", "Romanian", "Russian", "Serbian", "Shona", "Sinhala", "Slovak", "Slovene", "Somali", "Spanish", "Sundanese", "Swahili", "Swedish", "Tagalog", "Tamil", "Telugu", "Thai", "Turkish", "Ukrainian", "Urdu", "Uzbek", "Vietnamese", "Yoruba", "Zulu" ], "title": "Language option", "description": "A predefined option from the available language choices." }, "keywords": { "title": "[optional] Keywords", "description": "An array of keyword, each between 1 and 32 characters or `null`.", "examples": [ [ "Javascript", "React", "Typescript" ], [ "Design", "UI", "UX" ], [ "Python", "Data Science" ] ], "anyOf": [ { "title": "[optional] Keywords", "description": "An array of keyword, each between 1 and 32 characters or `null`.", "$ref": "#/$defs/keywords" }, { "type": "null" } ] } }, "required": [ "fluency", "language" ], "additionalProperties": false } }, { "type": "null" } ] }, "location": { "title": "Location", "description": "The location section contains your geographical information, such as city, address, country, and postal code.", "anyOf": [ { "type": "object", "properties": { "city": { "type": "string", "minLength": 2, "maxLength": 64, "title": "City", "description": "The city where you are located.", "examples": [ "San Francisco", "New York", "London", "Tokyo" ] }, "address": { "title": "[optional] Address", "description": "Your full address including street, apartment, etc or `null`.", "examples": [ "123 Main Street, Apt 4B", "456 Oak Avenue", "789 Pine Road, Suite 100" ], "anyOf": [ { "type": "string", "minLength": 4, "maxLength": 256, "title": "[optional] Address", "description": "Your full address including street, apartment, etc or `null`.", "examples": [ "123 Main Street, Apt 4B", "456 Oak Avenue", "789 Pine Road, Suite 100" ] }, { "type": "null" } ] }, "country": { "title": "[optional] Country option", "description": "A predefined option from the available country choices or `null`.", "anyOf": [ { "type": "string", "enum": [ "Afghanistan", "Aland Islands", "Albania", "Algeria", "American Samoa", "Andorra", "Angola", "Anguilla", "Antarctica", "Antigua And Barbuda", "Argentina", "Armenia", "Aruba", "Australia", "Austria", "Azerbaijan", "Bahrain", "Bangladesh", "Barbados", "Belarus", "Belgium", "Belize", "Benin", "Bermuda", "Bhutan", "Bolivia", "Bonaire, Sint Eustatius and Saba", "Bosnia and Herzegovina", "Botswana", "Bouvet Island", "Brazil", "British Indian Ocean Territory", "Brunei", "Bulgaria", "Burkina Faso", "Burundi", "Cambodia", "Cameroon", "Canada", "Cape Verde", "Cayman Islands", "Central African Republic", "Chad", "Chile", "China", "Christmas Island", "Cocos (Keeling) Islands", "Colombia", "Comoros", "Congo", "Cook Islands", "Costa Rica", "Cote D'Ivoire (Ivory Coast)", "Croatia", "Cuba", "Curaçao", "Cyprus", "Czech Republic", "Democratic Republic of the Congo", "Denmark", "Djibouti", "Dominica", "Dominican Republic", "East Timor", "Ecuador", "Egypt", "El Salvador", "Equatorial Guinea", "Eritrea", "Estonia", "Ethiopia", "Falkland Islands", "Faroe Islands", "Fiji Islands", "Finland", "France", "French Guiana", "French Polynesia", "French Southern Territories", "Gabon", "Gambia The", "Georgia", "Germany", "Ghana", "Gibraltar", "Greece", "Greenland", "Grenada", "Guadeloupe", "Guam", "Guatemala", "Guernsey and Alderney", "Guinea", "Guinea-Bissau", "Guyana", "Haiti", "Heard Island and McDonald Islands", "Honduras", "Hong Kong", "Hungary", "Iceland", "India", "Indonesia", "Iran", "Iraq", "Ireland", "Israel", "Italy", "Jamaica", "Japan", "Jersey", "Jordan", "Kazakhstan", "Kenya", "Kiribati", "Kosovo", "Kuwait", "Kyrgyzstan", "Laos", "Latvia", "Lebanon", "Lesotho", "Liberia", "Libya", "Liechtenstein", "Lithuania", "Luxembourg", "Macau", "Madagascar", "Malawi", "Malaysia", "Maldives", "Mali", "Malta", "Man (Isle of)", "Marshall Islands", "Martinique", "Mauritania", "Mauritius", "Mayotte", "Mexico", "Micronesia", "Moldova", "Monaco", "Mongolia", "Montenegro", "Montserrat", "Morocco", "Mozambique", "Myanmar", "Namibia", "Nauru", "Nepal", "Netherlands", "New Caledonia", "New Zealand", "Nicaragua", "Niger", "Nigeria", "Niue", "Norfolk Island", "North Korea", "North Macedonia", "Northern Mariana Islands", "Norway", "Oman", "Pakistan", "Palau", "Palestinian Territory Occupied", "Panama", "Papua new Guinea", "Paraguay", "Peru", "Philippines", "Pitcairn Island", "Poland", "Portugal", "Puerto Rico", "Qatar", "Reunion", "Romania", "Russia", "Rwanda", "Saint Helena", "Saint Kitts And Nevis", "Saint Lucia", "Saint Pierre and Miquelon", "Saint Vincent And The Grenadines", "Saint-Barthelemy", "Saint-Martin (French part)", "Samoa", "San Marino", "Sao Tome and Principe", "Saudi Arabia", "Senegal", "Serbia", "Seychelles", "Sierra Leone", "Singapore", "Sint Maarten (Dutch part)", "Slovakia", "Slovenia", "Solomon Islands", "Somalia", "South Africa", "South Georgia", "South Korea", "South Sudan", "Spain", "Sri Lanka", "Sudan", "Suriname", "Svalbard And Jan Mayen Islands", "Swaziland", "Sweden", "Switzerland", "Syria", "Taiwan", "Tajikistan", "Tanzania", "Thailand", "The Bahamas", "Togo", "Tokelau", "Tonga", "Trinidad And Tobago", "Tunisia", "Türkiye", "Turkmenistan", "Turks And Caicos Islands", "Tuvalu", "Uganda", "Ukraine", "United Arab Emirates", "United Kingdom", "United States", "United States Minor Outlying Islands", "Uruguay", "Uzbekistan", "Vanuatu", "Vatican City State (Holy See)", "Venezuela", "Vietnam", "Virgin Islands (British)", "Virgin Islands (US)", "Wallis And Futuna Islands", "Western Sahara", "Yemen", "Zambia", "Zimbabwe" ], "title": "[optional] Country option", "description": "A predefined option from the available country choices or `null`." }, { "type": "null" } ] }, "postalCode": { "title": "[optional] Postal Code", "description": "Your postal or ZIP code or `null`.", "examples": [ "94102", "10001", "SW1A 1AA", "100-0001" ], "anyOf": [ { "type": "string", "minLength": 2, "maxLength": 16, "title": "[optional] Postal Code", "description": "Your postal or ZIP code or `null`.", "examples": [ "94102", "10001", "SW1A 1AA", "100-0001" ] }, { "type": "null" } ] }, "region": { "title": "[optional] Region", "description": "Your state, province, or region or `null`.", "examples": [ "California", "New York", "England", "Tokyo" ], "anyOf": [ { "type": "string", "minLength": 2, "maxLength": 64, "title": "[optional] Region", "description": "Your state, province, or region or `null`.", "examples": [ "California", "New York", "England", "Tokyo" ] }, { "type": "null" } ] } }, "required": [ "city" ], "additionalProperties": false }, { "type": "null" } ] }, "profiles": { "title": "Profiles", "description": "The profiles section contains your online presence, including social media and professional network profiles.", "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "network": { "type": "string", "enum": [ "Behance", "Dribbble", "Facebook", "GitHub", "Gitlab", "Instagram", "Line", "LinkedIn", "Medium", "Pinterest", "Reddit", "Snapchat", "Stack Overflow", "Telegram", "TikTok", "Twitch", "Twitter", "Vimeo", "Weibo", "WeChat", "WhatsApp", "YouTube", "Zhihu" ], "title": "Network option", "description": "A predefined option from the available network choices." }, "username": { "type": "string", "minLength": 2, "maxLength": 64, "title": "Username", "description": "Your username or handle on the social network.", "examples": [ "john_doe", "jane.smith", "dev_engineer", "designer_123" ] }, "url": { "title": "[optional] URL", "description": "A valid URL with maximum length of 256 characters or `null`.", "examples": [ "https://yamlresume.dev", "https://ppresume.com", "https://github.com/yamlresume/yamlresume", "https://linkedin.com/in/xiaohanyu1988", "https://www.example.com" ], "anyOf": [ { "title": "[optional] URL", "description": "A valid URL with maximum length of 256 characters or `null`.", "$ref": "#/$defs/url" }, { "type": "null" } ] } }, "required": [ "network", "username" ], "additionalProperties": false } }, { "type": "null" } ] }, "projects": { "title": "Projects", "description": "The projects section contains your personal and professional projects, including technical details, timelines, and outcomes.", "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "minLength": 2, "maxLength": 128, "title": "Name", "description": "The name of the project.", "examples": [ "Andy Dufresne", "Xiao Hanyu", "Jane Smith", "Dr. Robert John" ] }, "startDate": { "type": "string", "minLength": 4, "maxLength": 32, "title": "Start date", "description": "A valid date string that can be parsed by `Date.parse`.", "examples": [ "2025", "2025-01-01", "Jul 2025", "July 3, 2025", "2025-02-02T00:00:03.123Z" ] }, "summary": { "$ref": "#/$defs/summary" }, "description": { "title": "[optional] Description", "description": "A detailed description of the project and your role or `null`.", "examples": [ "Led development of a full-stack web application", "Designed and implemented REST API endpoints", "Managed team of 5 developers for mobile app development" ], "anyOf": [ { "type": "string", "minLength": 4, "maxLength": 128, "title": "[optional] Description", "description": "A detailed description of the project and your role or `null`.", "examples": [ "Led development of a full-stack web application", "Designed and implemented REST API endpoints", "Managed team of 5 developers for mobile app development" ] }, { "type": "null" } ] }, "endDate": { "title": "[optional] End date", "description": "A valid date string that can be parsed by `Date.parse` or `null`.", "examples": [ "2025", "2025-01-01", "Jul 2025", "July 3, 2025", "2025-02-02T00:00:03.123Z" ], "anyOf": [ { "type": "string", "minLength": 4, "maxLength": 32, "title": "[optional] End date", "description": "A valid date string that can be parsed by `Date.parse` or `null`.", "examples": [ "2025", "2025-01-01", "Jul 2025", "July 3, 2025", "2025-02-02T00:00:03.123Z" ] }, { "type": "null" } ] }, "keywords": { "title": "[optional] Keywords", "description": "An array of keyword, each between 1 and 32 characters or `null`.", "examples": [ [ "Javascript", "React", "Typescript" ], [ "Design", "UI", "UX" ], [ "Python", "Data Science" ] ], "anyOf": [ { "title": "[optional] Keywords", "description": "An array of keyword, each between 1 and 32 characters or `null`.", "$ref": "#/$defs/keywords" }, { "type": "null" } ] }, "url": { "title": "[optional] URL", "description": "A valid URL with maximum length of 256 characters or `null`.", "examples": [ "https://yamlresume.dev", "https://ppresume.com", "https://github.com/yamlresume/yamlresume", "https://linkedin.com/in/xiaohanyu1988", "https://www.example.com" ], "anyOf": [ { "title": "[optional] URL", "description": "A valid URL with maximum length of 256 characters or `null`.", "$ref": "#/$defs/url" }, { "type": "null" } ] } }, "required": [ "name", "startDate", "summary" ], "additionalProperties": false } }, { "type": "null" } ] }, "publications": { "title": "Publications", "description": "The publications section contains your academic and professional publications, including papers, articles, and research works.", "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "minLength": 2, "maxLength": 128, "title": "Name", "description": "The name of the publication.", "examples": [ "Andy Dufresne", "Xiao Hanyu", "Jane Smith", "Dr. Robert John" ] }, "publisher": { "type": "string", "minLength": 2, "maxLength": 128, "title": "Publisher", "description": "The organization that published the work.", "examples": [ "ACM", "IEEE", "Springer", "Nature Publishing Group" ] }, "releaseDate": { "title": "[optional] Release date", "description": "A valid date string that can be parsed by `Date.parse` or `null`.", "examples": [ "2025", "2025-01-01", "Jul 2025", "July 3, 2025", "2025-02-02T00:00:03.123Z" ], "anyOf": [ { "type": "string", "minLength": 4, "maxLength": 32, "title": "[optional] Release date", "description": "A valid date string that can be parsed by `Date.parse` or `null`.", "examples": [ "2025", "2025-01-01", "Jul 2025", "July 3, 2025", "2025-02-02T00:00:03.123Z" ] }, { "type": "null" } ] }, "summary": { "title": "[optional] Summary", "description": "A summary text between 16 and 1024 characters or `null`.", "examples": [ "Experienced software engineer with 5+ years in full-stack development.", "Creative designer passionate about user experience and modern design principles.", "Dedicated project manager with proven track record of delivering complex projects on time and budget." ], "anyOf": [ { "title": "[optional] Summary", "description": "A summary text between 16 and 1024 characters or `null`.", "$ref": "#/$defs/summary" }, { "type": "null" } ] }, "url": { "title": "[optional] URL", "description": "A valid URL with maximum length of 256 characters or `null`.", "examples": [ "https://yamlresume.dev", "https://ppresume.com", "https://github.com/yamlresume/yamlresume", "https://linkedin.com/in/xiaohanyu1988", "https://www.example.com" ], "anyOf": [ { "title": "[optional] URL", "description": "A valid URL with maximum length of 256 characters or `null`.", "$ref": "#/$defs/url" }, { "type": "null" } ] } }, "required": [ "name", "publisher" ], "additionalProperties": false } }, { "type": "null" } ] }, "references": { "title": "References", "description": "The references section contains your professional references, including contact information and relationships.", "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "minLength": 2, "maxLength": 128, "title": "Name", "description": "The name of the reference.", "examples": [ "Andy Dufresne", "Xiao Hanyu", "Jane Smith", "Dr. Robert John" ] }, "summary": { "$ref": "#/$defs/summary" }, "email": { "title": "[optional] Email", "description": "A valid email address or `null`.", "examples": [ "hi@ppresume.com", "first.last@company.org", "test+tag@domain.co.uk" ], "anyOf": [ { "title": "[optional] Email", "description": "A valid email address or `null`.", "$ref": "#/$defs/email" }, { "type": "null" } ] }, "phone": { "title": "[optional] Phone", "description": "A valid phone number that may include country code, parentheses, spaces, and hyphens or `null`.", "examples": [ "555-123-4567", "+44 20 7946 0958", "(555) 123-4567" ], "anyOf": [ { "title": "[optional] Phone", "description": "A valid phone number that may include country code, parentheses, spaces, and hyphens or `null`.", "$ref": "#/$defs/phone" }, { "type": "null" } ] }, "relationship": { "title": "[optional] Relationship", "description": "Your professional relationship with the reference or `null`.", "examples": [ "Former Manager", "Colleague", "Professor", "Client" ], "anyOf": [ { "type": "string", "minLength": 2, "maxLength": 128, "title": "[optional] Relationship", "description": "Your professional relationship with the reference or `null`.", "examples": [ "Former Manager", "Colleague", "Professor", "Client" ] }, { "type": "null" } ] } }, "required": [ "name", "summary" ], "additionalProperties": false } }, { "type": "null" } ] }, "skills": { "title": "Skills", "description": "The skills section contains your technical and professional skills, including proficiency levels and related keywords.", "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "level": { "type": "string", "enum": [ "Novice", "Beginner", "Intermediate", "Advanced", "Expert", "Master" ], "title": "Level option", "description": "A predefined option from the available level choices." }, "name": { "type": "string", "minLength": 2, "maxLength": 128, "title": "Name", "description": "The name of the skill.", "examples": [ "Andy Dufresne", "Xiao Hanyu", "Jane Smith", "Dr. Robert John" ] }, "keywords": { "title": "[optional] Keywords", "description": "An array of keyword, each between 1 and 32 characters or `null`.", "examples": [ [ "Javascript", "React", "Typescript" ], [ "Design", "UI", "UX" ], [ "Python", "Data Science" ] ], "anyOf": [ { "title": "[optional] Keywords", "description": "An array of keyword, each between 1 and 32 characters or `null`.", "$ref": "#/$defs/keywords" }, { "type": "null" } ] } }, "required": [ "level", "name" ], "additionalProperties": false } }, { "type": "null" } ] }, "volunteer": { "title": "Volunteer", "description": "The volunteer section contains your community service and volunteer work, including organizations, roles, and contributions.", "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "organization": { "type": "string", "minLength": 2, "maxLength": 128, "title": "Organization", "description": "The organization where you volunteered.", "examples": [ "Red Cross", "Habitat for Humanity", "Local Food Bank", "Animal Shelter" ] }, "position": { "type": "string", "minLength": 2, "maxLength": 64, "title": "Position", "description": "Your role or position in the volunteer organization.", "examples": [ "Event Coordinator", "Tutor", "Fundraiser", "Board Member" ] }, "startDate": { "type": "string", "minLength": 4, "maxLength": 32, "title": "Start date", "description": "A valid date string that can be parsed by `Date.parse`.", "examples": [ "2025", "2025-01-01", "Jul 2025", "July 3, 2025", "2025-02-02T00:00:03.123Z" ] }, "summary": { "$ref": "#/$defs/summary" }, "endDate": { "title": "[optional] End date", "description": "A valid date string that can be parsed by `Date.parse` or `null`.", "examples": [ "2025", "2025-01-01", "Jul 2025", "July 3, 2025", "2025-02-02T00:00:03.123Z" ], "anyOf": [ { "type": "string", "minLength": 4, "maxLength": 32, "title": "[optional] End date", "description": "A valid date string that can be parsed by `Date.parse` or `null`.", "examples": [ "2025", "2025-01-01", "Jul 2025", "July 3, 2025", "2025-02-02T00:00:03.123Z" ] }, { "type": "null" } ] }, "url": { "title": "[optional] URL", "description": "A valid URL with maximum length of 256 characters or `null`.", "examples": [ "https://yamlresume.dev", "https://ppresume.com", "https://github.com/yamlresume/yamlresume", "https://linkedin.com/in/xiaohanyu1988", "https://www.example.com" ], "anyOf": [ { "title": "[optional] URL", "description": "A valid URL with maximum length of 256 characters or `null`.", "$ref": "#/$defs/url" }, { "type": "null" } ] } }, "required": [ "organization", "position", "startDate", "summary" ], "additionalProperties": false } }, { "type": "null" } ] }, "work": { "title": "Work", "description": "The work section contains your professional experience, including job titles, companies, and responsibilities.", "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "minLength": 2, "maxLength": 128, "title": "Name", "description": "The name of the company or organization you worked for.", "examples": [ "Google", "Microsoft", "Apple", "Amazon" ] }, "position": { "type": "string", "minLength": 2, "maxLength": 64, "title": "Position", "description": "Your job title or position at the company.", "examples": [ "Software Engineer", "Product Manager", "Data Scientist", "UX Designer" ] }, "startDate": { "type": "string", "minLength": 4, "maxLength": 32, "title": "Start date", "description": "A valid date string that can be parsed by `Date.parse`.", "examples": [ "2025", "2025-01-01", "Jul 2025", "July 3, 2025", "2025-02-02T00:00:03.123Z" ] }, "summary": { "$ref": "#/$defs/summary" }, "endDate": { "title": "[optional] End date", "description": "A valid date string that can be parsed by `Date.parse` or `null`.", "examples": [ "2025", "2025-01-01", "Jul 2025", "July 3, 2025", "2025-02-02T00:00:03.123Z" ], "anyOf": [ { "type": "string", "minLength": 4, "maxLength": 32, "title": "[optional] End date", "description": "A valid date string that can be parsed by `Date.parse` or `null`.", "examples": [ "2025", "2025-01-01", "Jul 2025", "July 3, 2025", "2025-02-02T00:00:03.123Z" ] }, { "type": "null" } ] }, "keywords": { "title": "[optional] Keywords", "description": "An array of keyword, each between 1 and 32 characters or `null`.", "examples": [ [ "Javascript", "React", "Typescript" ], [ "Design", "UI", "UX" ], [ "Python", "Data Science" ] ], "anyOf": [ { "title": "[optional] Keywords", "description": "An array of keyword, each between 1 and 32 characters or `null`.", "$ref": "#/$defs/keywords" }, { "type": "null" } ] }, "url": { "title": "[optional] URL", "description": "A valid URL with maximum length of 256 characters or `null`.", "examples": [ "https://yamlresume.dev", "https://ppresume.com", "https://github.com/yamlresume/yamlresume", "https://linkedin.com/in/xiaohanyu1988", "https://www.example.com" ], "anyOf": [ { "title": "[optional] URL", "description": "A valid URL with maximum length of 256 characters or `null`.", "$ref": "#/$defs/url" }, { "type": "null" } ] } }, "required": [ "name", "position", "startDate", "summary" ], "additionalProperties": false } }, { "type": "null" } ] } }, "required": [ "basics", "education" ], "additionalProperties": false }, "locale": { "title": "Locale", "description": "Top-level locale language settings, determining the language used for the resume.", "anyOf": [ { "type": "object", "properties": { "language": { "title": "[optional] Locale language option", "description": "A predefined option from the available locale language choices or `null`.", "anyOf": [ { "type": "string", "enum": [ "en", "zh-hans", "zh-hant-hk", "zh-hant-tw", "es", "fr", "no", "nl", "ja", "de", "id" ], "title": "[optional] Locale language option", "description": "A predefined option from the available locale language choices or `null`." }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ] }, "layouts": { "title": "Layouts", "description": "Multiple output layouts configuration as a discriminated union array, supporting engines like \"latex\", \"markdown\", and \"html\".", "anyOf": [ { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "engine": { "type": "string", "const": "html" }, "template": { "title": "Template", "description": "The template section contains the resume template selection, determining the overall visual style and layout.", "anyOf": [ { "type": "string", "enum": [ "calm", "vscode" ], "title": "[optional] Html template option", "description": "A predefined option from the available HTML template choices or `null`." }, { "type": "null" } ] }, "typography": { "title": "Typography", "description": "The typography section contains font settings, including font size and line spacing options for HTML output.", "anyOf": [ { "type": "object", "properties": { "fontSize": { "title": "[optional] Html font size option", "description": "A predefined option from the available HTML font size choices or `null`.", "anyOf": [ { "type": "string", "enum": [ "14px", "15px", "16px", "17px", "18px", "19px", "20px" ], "title": "[optional] Html font size option", "description": "A predefined option from the available HTML font size choices or `null`." }, { "type": "null" } ] }, "fontFamily": { "title": "[optional] Font Family", "description": "A comma-separated list of font families to use. The first available font will be used or `null`.", "anyOf": [ { "type": "string", "title": "[optional] Font Family", "description": "A comma-separated list of font families to use. The first available font will be used or `null`.", "example": "Monaco, Helvetica" }, { "type": "null" } ] }, "lineSpacing": { "title": "[optional] Line spacing option", "description": "A predefined option from the available line spacing choices or `null`.", "anyOf": [ { "type": "string", "enum": [ "tight", "snug", "normal", "relaxed", "loose" ], "title": "[optional] Line spacing option", "description": "A predefined option from the available line spacing choices or `null`." }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ] }, "advanced": { "title": "Advanced", "description": "The Advanced section contains advanced HTML settings.", "anyOf": [ { "type": "object", "properties": { "showIcons": { "default": true, "type": "boolean" }, "title": { "type": "string" }, "footer": { "default": "Generated by YAMLResume", "type": "string" }, "description": { "type": "string" }, "keywords": { "type": "string" } }, "required": [ "showIcons", "footer" ], "additionalProperties": false }, { "type": "null" } ] }, "sections": { "title": "Sections", "description": "Section customization settings.", "anyOf": [ { "type": "object", "properties": { "aliases": { "title": "Aliases", "description": "Section alias customization settings.", "anyOf": [ { "type": "object", "properties": { "basics": { "title": "[optional] basics", "description": "The name of the alias for basics section or `null`.", "anyOf": [ { "type": "string", "minLength": 2, "maxLength": 128, "title": "[optional] basics", "description": "The name of the alias for basics section or `null`." }, { "type": "null" } ] }, "education": { "title": "[optional] education", "description": "The name of the alias for education section or `null`.", "anyOf": [ { "type": "string", "minLength": 2, "maxLength": 128, "title": "[optional] education", "description": "The name of the alias for education section or `null`." }, { "type": "null" } ] }, "work": { "title": "[optional] work", "description": "The name of the alias for work section or `null`.", "anyOf": [ { "type": "string", "minLength": 2, "maxLength": 128, "title": "[optional] work", "description": "The name of the alias for work section or `null`." }, { "type": "null" } ] }, "volunteer": { "title": "[optional] volunteer", "description": "The name of the alias for volunteer section or `null`.", "anyOf": [ { "type": "string", "minLength": 2, "maxLength": 128, "title": "[optional] volunteer", "description": "The name of the alias for volunteer section or `null`." }, { "type": "null" } ] }, "awards": { "title": "[optional] awards", "description": "The name of the alias for awards section or `null`.", "anyOf": [ { "type": "string", "minLength": 2, "maxLength": 128, "title": "[optional] awards", "description": "The name of the alias for awards section or `null`." }, { "type": "null" } ] }, "certificates": { "title": "[optional] certificates", "description": "The name of the alias for certificates section or `null`.", "anyOf": [ { "type": "string", "minLength": 2, "maxLength": 128, "title": "[optional] certificates", "description": "The name of the alias for certificates section or `null`." }, { "type": "null" } ] }, "publications": { "title": "[optional] publications", "description": "The name of the alias for publications section or `null`.", "anyOf": [ { "type": "string", "minLength": 2, "maxLength": 128, "title": "[optional] publications", "description": "The name of the alias for publications section or `null`." }, { "type": "null" } ] }, "skills": { "title": "[optional] skills", "description": "The name of the alias for skills section or `null`.", "anyOf": [ { "type": "string", "minLength": 2, "maxLength": 128, "title": "[optional] skills", "description": "The name of the alias for skills section or `null`." }, { "type": "null" } ] }, "languages": { "title": "[optional] languages", "description": "The name of the alias for languages section or `null`.", "anyOf": [ { "type": "string", "minLength": 2, "maxLength": 128, "title": "[optional] languages", "description": "The name of the alias for languages section or `null`." }, { "type": "null" } ] }, "interests": { "title": "[optional] interests", "description": "The name of the alias for interests section or `null`.", "anyOf": [ { "type": "string", "minLength": 2, "maxLength": 128, "title": "[optional] interests", "description": "The name of the alias for interests section or `null`." }, { "type": "null" } ] }, "references": { "title": "[optional] references", "description": "The name of the alias for references section or `null`.", "anyOf": [ { "type": "string", "minLength": 2, "maxLength": 128, "title": "[optional] references", "description": "The name of the alias for references section or `null`." }, { "type": "null" } ] }, "projects": { "title": "[optional] projects", "description": "The name of the alias for projects section or `null`.", "anyOf": [ { "type": "string", "minLength": 2, "maxLength": 128, "title": "[optional] projects", "description": "The name of the alias for projects section or `null`." }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ] }, "order": { "title": "Order", "description": "Custom order for sections in the final output.", "anyOf": [ { "type": "array", "items": { "type": "string", "enum": [ "basics", "education", "work", "volunteer", "awards", "certificates", "publications", "skills", "languages", "interests", "references", "projects" ], "title": "Section option", "description": "A predefined option from the available section choices." } }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "engine" ], "additionalProperties": false, "title": "HTML Engine Layout" }, { "type": "object", "properties": { "engine": { "type": "string", "const": "latex" }, "page": { "title": "Page", "description": "The page section contains page display settings, including whether to show page numbers and margins.", "anyOf": [ { "type": "object", "properties": { "showPageNumbers": { "title": "[optional] Show Page Numbers", "description": "Whether to show page numbers on the page or `null`.", "anyOf": [ { "type": "boolean", "title": "[optional] Show Page Numbers", "description": "Whether to show page numbers on the page or `null`." }, { "type": "null" } ] }, "paperSize": { "title": "[optional] Latex paper size option", "description": "A predefined option from the available LaTeX paper size choices or `null`.", "anyOf": [ { "type": "string", "enum": [ "a4", "letter" ], "title": "[optional] Latex paper size option", "description": "A predefined option from the available LaTeX paper size choices or `null`." }, { "type": "null" } ] }, "margins": { "title": "Margins", "description": "The margins section contains page margin settings, including top, bottom, left, and right margins.", "anyOf": [ { "type": "object", "properties": { "top": { "title": "[optional] Top margin size", "description": "A positive number followed by valid units: cm, pt, or in. Examples: \"2.5cm\", \"1in\", \"72pt\" or `null`.", "examples": [ "2.5cm", "1in", "72pt", "0.5cm", "12pt" ], "anyOf": [ { "type": "string", "minLength": 2, "maxLength": 32, "title": "[optional] Top margin size", "description": "A positive number followed by valid units: cm, pt, or in. Examples: \"2.5cm\", \"1in\", \"72pt\" or `null`.", "examples": [ "2.5cm", "1in", "72pt", "0.5cm", "12pt" ] }, { "type": "null" } ] }, "bottom": { "title": "[optional] Bottom margin size", "description": "A positive number followed by valid units: cm, pt, or in. Examples: \"2.5cm\", \"1in\", \"72pt\" or `null`.", "examples": [ "2.5cm", "1in", "72pt", "0.5cm", "12pt" ], "anyOf": [ { "type": "string", "minLength": 2, "maxLength": 32, "title": "[optional] Bottom margin size", "description": "A positive number followed by valid units: cm, pt, or in. Examples: \"2.5cm\", \"1in\", \"72pt\" or `null`.", "examples": [ "2.5cm", "1in", "72pt", "0.5cm", "12pt" ] }, { "type": "null" } ] }, "left": { "title": "[optional] Left margin size", "description": "A positive number followed by valid units: cm, pt, or in. Examples: \"2.5cm\", \"1in\", \"72pt\" or `null`.", "examples": [ "2.5cm", "1in", "72pt", "0.5cm", "12pt" ], "anyOf": [ { "type": "string", "minLength": 2, "maxLength": 32, "title": "[optional] Left margin size", "description": "A positive number followed by valid units: cm, pt, or in. Examples: \"2.5cm\", \"1in\", \"72pt\" or `null`.", "examples": [ "2.5cm", "1in", "72pt", "0.5cm", "12pt" ] }, { "type": "null" } ] }, "right": { "title": "[optional] Right margin size", "description": "A positive number followed by valid units: cm, pt, or in. Examples: \"2.5cm\", \"1in\", \"72pt\" or `null`.", "examples": [ "2.5cm", "1in", "72pt", "0.5cm", "12pt" ], "anyOf": [ { "type": "string", "minLength": 2, "maxLength": 32, "title": "[optional] Right margin size", "description": "A positive number followed by valid units: cm, pt, or in. Examples: \"2.5cm\", \"1in\", \"72pt\" or `null`.", "examples": [ "2.5cm", "1in", "72pt", "0.5cm", "12pt" ] }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ] }, "template": { "title": "Template", "description": "The template section contains the resume template selection, determining the overall visual style and layout.", "anyOf": [ { "type": "string", "enum": [ "jake", "moderncv-banking", "moderncv-casual", "moderncv-classic" ], "title": "[optional] Latex template option", "description": "A predefined option from the available LaTeX template choices or `null`." }, { "type": "null" } ] }, "typography": { "title": "Typography", "description": "The typography section contains font settings, including font size options and link styling.", "anyOf": [ { "type": "object", "properties": { "fontSize": { "title": "[optional] Latex font size option", "description": "A predefined option from the available LaTeX font size choices or `null`.", "anyOf": [ { "type": "string", "enum": [ "10pt", "11pt", "12pt" ], "title": "[optional] Latex font size option", "description": "A predefined option from the available LaTeX font size choices or `null`." }, { "type": "null" } ] }, "fontFamily": { "title": "[optional] Font Family", "description": "A comma-separated list of font families to use. The first available font will be used or `null`.", "anyOf": [ { "type": "string", "title": "[optional] Font Family", "description": "A comma-separated list of font families to use. The first available font will be used or `null`.", "example": "Monaco, Helvetica" }, { "type": "null" } ] }, "lineSpacing": { "title": "[optional] Line spacing option", "description": "A predefined option from the available line spacing choices or `null`.", "anyOf": [ { "type": "string", "enum": [ "tight", "snug", "normal", "relaxed", "loose" ], "title": "[optional] Line spacing option", "description": "A predefined option from the available line spacing choices or `null`." }, { "type": "null" } ] }, "links": { "title": "Typography Links", "description": "Link styling settings for typography.", "anyOf": [ { "type": "object", "properties": { "underline": { "default": false, "title": "Underline Links", "description": "Whether to underline links in the document.", "examples": [ false, true ], "type": "boolean" } }, "required": [ "underline" ], "additionalProperties": false }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ] }, "advanced": { "title": "Advanced", "description": "The Advanced section contains advanced latex settings, including fontspec package configurations.", "anyOf": [ { "type": "object", "properties": { "fontspec": { "anyOf": [ { "type": "object", "properties": { "numbers": { "title": "[optional] Latex fontspec numbers option", "description": "A predefined option from the available LaTeX fontspec numbers choices or `null`.", "anyOf": [ { "type": "string", "enum": [ "Lining", "OldStyle", "Auto" ], "title": "[optional] Latex fontspec numbers option", "description": "A predefined option from the available LaTeX fontspec numbers choices or `null`." }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ] }, "showIcons": { "default": true, "type": "boolean" }, "showUrls": { "default": true, "type": "boolean" } }, "required": [ "showIcons", "showUrls" ], "additionalProperties": false }, { "type": "null" } ] }, "sections": { "title": "Sections", "description": "Section customization settings.", "anyOf": [ { "type": "object", "properties": { "aliases": { "title": "Aliases", "description": "Section alias customization settings.", "anyOf": [ { "type": "object", "properties": { "basics": { "title": "[optional] basics", "description": "The name of the alias for basics section or `null`.", "anyOf": [ { "type": "string", "minLength": 2, "maxLength": 128, "title": "[optional] basics", "description": "The name of the alias for basics section or `null`." }, { "type": "null" } ] }, "education": { "title": "[optional] education", "description": "The name of the alias for education section or `null`.", "anyOf": [ { "type": "string", "minLength": 2, "maxLength": 128, "title": "[optional] education", "description": "The name of the alias for education section or `null`." }, { "type": "null" } ] }, "work": { "title": "[optional] work", "description": "The name of the alias for work section or `null`.", "anyOf": [ { "type": "string", "minLength": 2, "maxLength": 128, "title": "[optional] work", "description": "The name of the alias for work section or `null`." }, { "type": "null" } ] }, "volunteer": { "title": "[optional] volunteer", "description": "The name of the alias for volunteer section or `null`.", "anyOf": [ { "type": "string", "minLength": 2, "maxLength": 128, "title": "[optional] volunteer", "description": "The name of the alias for volunteer section or `null`." }, { "type": "null" } ] }, "awards": { "title": "[optional] awards", "description": "The name of the alias for awards section or `null`.", "anyOf": [ { "type": "string", "minLength": 2, "maxLength": 128, "title": "[optional] awards", "description": "The name of the alias for awards section or `null`." }, { "type": "null" } ] }, "certificates": { "title": "[optional] certificates", "description": "The name of the alias for certificates section or `null`.", "anyOf": [ { "type": "string", "minLength": 2, "maxLength": 128, "title": "[optional] certificates", "description": "The name of the alias for certificates section or `null`." }, { "type": "null" } ] }, "publications": { "title": "[optional] publications", "description": "The name of the alias for publications section or `null`.", "anyOf": [ { "type": "string", "minLength": 2, "maxLength": 128, "title": "[optional] publications", "description": "The name of the alias for publications section or `null`." }, { "type": "null" } ] }, "skills": { "title": "[optional] skills", "description": "The name of the alias for skills section or `null`.", "anyOf": [ { "type": "string", "minLength": 2, "maxLength": 128, "title": "[optional] skills", "description": "The name of the alias for skills section or `null`." }, { "type": "null" } ] }, "languages": { "title": "[optional] languages", "description": "The name of the alias for languages section or `null`.", "anyOf": [ { "type": "string", "minLength": 2, "maxLength": 128, "title": "[optional] languages", "description": "The name of the alias for languages section or `null`." }, { "type": "null" } ] }, "interests": { "title": "[optional] interests", "description": "The name of the alias for interests section or `null`.", "anyOf": [ { "type": "string", "minLength": 2, "maxLength": 128, "title": "[optional] interests", "description": "The name of the alias for interests section or `null`." }, { "type": "null" } ] }, "references": { "title": "[optional] references", "description": "The name of the alias for references section or `null`.", "anyOf": [ { "type": "string", "minLength": 2, "maxLength": 128, "title": "[optional] references", "description": "The name of the alias for references section or `null`." }, { "type": "null" } ] }, "projects": { "title": "[optional] projects", "description": "The name of the alias for projects section or `null`.", "anyOf": [ { "type": "string", "minLength": 2, "maxLength": 128, "title": "[optional] projects", "description": "The name of the alias for projects section or `null`." }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ] }, "order": { "title": "Order", "description": "Custom order for sections in the final output.", "anyOf": [ { "type": "array", "items": { "type": "string", "enum": [ "basics", "education", "work", "volunteer", "awards", "certificates", "publications", "skills", "languages", "interests", "references", "projects" ], "title": "Section option", "description": "A predefined option from the available section choices." } }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "engine" ], "additionalProperties": false, "title": "LaTeX Engine Layout" }, { "type": "object", "properties": { "engine": { "type": "string", "const": "markdown" }, "sections": { "title": "Sections", "description": "Section customization settings.", "anyOf": [ { "type": "object", "properties": { "aliases": { "title": "Aliases", "description": "Section alias customization settings.", "anyOf": [ { "type": "object", "properties": { "basics": { "title": "[optional] basics", "description": "The name of the alias for basics section or `null`.", "anyOf": [ { "type": "string", "minLength": 2, "maxLength": 128, "title": "[optional] basics", "description": "The name of the alias for basics section or `null`." }, { "type": "null" } ] }, "education": { "title": "[optional] education", "description": "The name of the alias for education section or `null`.", "anyOf": [ { "type": "string", "minLength": 2, "maxLength": 128, "title": "[optional] education", "description": "The name of the alias for education section or `null`." }, { "type": "null" } ] }, "work": { "title": "[optional] work", "description": "The name of the alias for work section or `null`.", "anyOf": [ { "type": "string", "minLength": 2, "maxLength": 128, "title": "[optional] work", "description": "The name of the alias for work section or `null`." }, { "type": "null" } ] }, "volunteer": { "title": "[optional] volunteer", "description": "The name of the alias for volunteer section or `null`.", "anyOf": [ { "type": "string", "minLength": 2, "maxLength": 128, "title": "[optional] volunteer", "description": "The name of the alias for volunteer section or `null`." }, { "type": "null" } ] }, "awards": { "title": "[optional] awards", "description": "The name of the alias for awards section or `null`.", "anyOf": [ { "type": "string", "minLength": 2, "maxLength": 128, "title": "[optional] awards", "description": "The name of the alias for awards section or `null`." }, { "type": "null" } ] }, "certificates": { "title": "[optional] certificates", "description": "The name of the alias for certificates section or `null`.", "anyOf": [ { "type": "string", "minLength": 2, "maxLength": 128, "title": "[optional] certificates", "description": "The name of the alias for certificates section or `null`." }, { "type": "null" } ] }, "publications": { "title": "[optional] publications", "description": "The name of the alias for publications section or `null`.", "anyOf": [ { "type": "string", "minLength": 2, "maxLength": 128, "title": "[optional] publications", "description": "The name of the alias for publications section or `null`." }, { "type": "null" } ] }, "skills": { "title": "[optional] skills", "description": "The name of the alias for skills section or `null`.", "anyOf": [ { "type": "string", "minLength": 2, "maxLength": 128, "title": "[optional] skills", "description": "The name of the alias for skills section or `null`." }, { "type": "null" } ] }, "languages": { "title": "[optional] languages", "description": "The name of the alias for languages section or `null`.", "anyOf": [ { "type": "string", "minLength": 2, "maxLength": 128, "title": "[optional] languages", "description": "The name of the alias for languages section or `null`." }, { "type": "null" } ] }, "interests": { "title": "[optional] interests", "description": "The name of the alias for interests section or `null`.", "anyOf": [ { "type": "string", "minLength": 2, "maxLength": 128, "title": "[optional] interests", "description": "The name of the alias for interests section or `null`." }, { "type": "null" } ] }, "references": { "title": "[optional] references", "description": "The name of the alias for references section or `null`.", "anyOf": [ { "type": "string", "minLength": 2, "maxLength": 128, "title": "[optional] references", "description": "The name of the alias for references section or `null`." }, { "type": "null" } ] }, "projects": { "title": "[optional] projects", "description": "The name of the alias for projects section or `null`.", "anyOf": [ { "type": "string", "minLength": 2, "maxLength": 128, "title": "[optional] projects", "description": "The name of the alias for projects section or `null`." }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ] }, "order": { "title": "Order", "description": "Custom order for sections in the final output.", "anyOf": [ { "type": "array", "items": { "type": "string", "enum": [ "basics", "education", "work", "volunteer", "awards", "certificates", "publications", "skills", "languages", "interests", "references", "projects" ], "title": "Section option", "description": "A predefined option from the available section choices." } }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "engine" ], "additionalProperties": false, "title": "Markdown Engine Layout" } ] } }, { "type": "null" } ] } }, "required": [ "content" ], "additionalProperties": false, "$id": "https://yamlresume.dev/schema.json", "title": "YAMLResume Schema", "description": "JSON Schema for YAMLResume resume format.", "version": "0.12.3", "license": "MIT", "keywords": [ "Resume", "CV", "YAML", "LaTeX", "PDF", "YAMLResume", "Markdown" ], "$defs": { "email": { "type": "string", "format": "email", "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$", "id": "email", "title": "Email", "description": "A valid email address.", "examples": [ "hi@ppresume.com", "first.last@company.org", "test+tag@domain.co.uk" ] }, "phone": { "type": "string", "pattern": "^[+]?[(]?[0-9\\s-]{1,15}[)]?[0-9\\s-]{1,15}$", "id": "phone", "title": "Phone", "description": "A valid phone number that may include country code, parentheses, spaces, and hyphens.", "examples": [ "555-123-4567", "+44 20 7946 0958", "(555) 123-4567" ] }, "summary": { "type": "string", "minLength": 16, "maxLength": 1024, "id": "summary", "title": "Summary", "description": "A summary text between 16 and 1024 characters.", "examples": [ "Experienced software engineer with 5+ years in full-stack development.", "Creative designer passionate about user experience and modern design principles.", "Dedicated project manager with proven track record of delivering complex projects on time and budget." ] }, "url": { "type": "string", "maxLength": 256, "format": "uri", "id": "url", "title": "URL", "description": "A valid URL with maximum length of 256 characters.", "examples": [ "https://yamlresume.dev", "https://ppresume.com", "https://github.com/yamlresume/yamlresume", "https://linkedin.com/in/xiaohanyu1988", "https://www.example.com" ] }, "keywords": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 32 }, "id": "keywords", "title": "Keywords", "description": "An array of keyword, each between 1 and 32 characters.", "examples": [ [ "Javascript", "React", "Typescript" ], [ "Design", "UI", "UX" ], [ "Python", "Data Science" ] ] } } }