Tipos
Definiciones de tipos de TypeScript para el documento del currículum, incluidas las secciones de contenido y la configuración de diseño.
Este documento describe los tipos de TypeScript que definen la estructura de un currículum en YAMLResume. Como proyecto TypeScript, YAMLResume emplea tipado estático para garantizar consistencia de datos. Aquí se presenta una visión general de las estructuras núcleo para representar la información del currículum, incluyendo datos personales, educación, experiencia, habilidades y más.
Puedes consultar types/index.ts para la fuente de verdad.
Entender estos tipos es esencial para contribuir o extender la funcionalidad de YAMLResume.
Este documento sirve como referencia definitiva para crear un YAMLResume válido, aclarando la diferencia entre campos opcionales y obligatorios. Para compilar con éxito, un currículum mínimo debe incluir:
content.basics.nameeducation[number].areaeducation[number].degreeeducation[number].institutioneducation[number].startDate
Ejemplo mínimo viable:
content:
basics:
name: Xiao Hanyu
education:
- area: Computer Science and Technology
degree: Bachelor
institution: Zhejiang University
startDate: Sep, 2007Resume
Define la estructura global del currículum (contenido y layout).
| Prop | Tipo | Requerido | Descripción |
|---|---|---|---|
content | Content | ✅ | Estructura del contenido completo del currículum. |
layouts? | Layouts | ⬜️ | Configuración general del layout. |
locale? | Locale | ⬜️ | Configuración general de localización. |
Diagrama de alto nivel:
Content
Estructura del contenido completo del currículum.
| Prop | Tipo | Requerido | Descripción |
|---|---|---|---|
basics | BasicsItem | ✅ | Información personal y de contacto principal. |
education | EducationItem[] | ✅ | Conjunto de experiencias educativas. |
awards? | AwardItem[] | ⬜️ | Conjunto de premios y reconocimientos. |
certificates? | CertificateItem[] | ⬜️ | Conjunto de certificaciones y credenciales. |
interests? | InterestItem[] | ⬜️ | Intereses, hobbies o actividades personales. |
languages? | LanguageItem[] | ⬜️ | Competencias lingüísticas. |
location? | LocationItem | ⬜️ | Información de localización. |
projects? | ProjectItem[] | ⬜️ | Proyectos. |
profiles? | ProfileItem[] | ⬜️ | Perfiles online. |
publications? | PublicationItem[] | ⬜️ | Publicaciones. |
references? | ReferenceItem[] | ⬜️ | Referencias. |
skills? | SkillItem[] | ⬜️ | Habilidades. |
volunteer? | VolunteerItem[] | ⬜️ | Experiencias de voluntariado. |
work? | WorkItem[] | ⬜️ | Experiencias laborales e historial de empleo. |
AwardItem
Representa un premio u honor recibido.
| Prop | Tipo | Req. | Descripción |
|---|---|---|---|
awarder | string | ✅ | Organización que otorga el premio. |
title | string | ✅ | Nombre del premio. |
date? | string | ⬜️ | Fecha (p. ej., "2020", "Oct 2020"). |
summary? | string | ⬜️ | Breve descripción. |
BasicsItem
Información personal principal.
| Prop | Tipo | Req. | Descripción |
|---|---|---|---|
name | string | ✅ | Nombre completo. |
email? | string | ⬜️ | Email. |
headline? | string | ⬜️ | Titular profesional (p. ej., "Software Engineer"). |
phone? | string | ⬜️ | Teléfono. |
summary? | string | ⬜️ | Resumen profesional. |
url? | string | ⬜️ | Sitio o portafolio. |
CertificateItem
| Prop | Tipo | Req. | Descripción |
|---|---|---|---|
issuer | string | ✅ | Entidad emisora. |
name | string | ✅ | Nombre del certificado. |
date? | string | ⬜️ | Fecha obtenida. |
url? | string | ⬜️ | Enlace de verificación u otro. |
EducationItem
| Prop | Tipo | Req. | Descripción |
|---|---|---|---|
area | string | ✅ | Área de estudio. |
degree | Degree | ✅ | Tipo de grado. |
institution | string | ✅ | Institución. |
startDate | string | ✅ | Fecha de inicio. |
courses? | string[] | ⬜️ | Cursos. |
endDate? | string | ⬜️ | Fecha de fin (vacío implica "Actual"). |
summary? | string | ⬜️ | Descripción/logros. |
score? | string | ⬜️ | Calificación/GPA. |
url? | string | ⬜️ | Enlace relacionado. |
InterestItem
| Prop | Tipo | Req. | Descripción |
|---|---|---|---|
name | string | ✅ | Nombre del interés. |
keywords? | string[] | ⬜️ | Palabras clave relacionadas. |
LanguageItem
| Prop | Tipo | Req. | Descripción |
|---|---|---|---|
fluency | Fluency | ✅ | Nivel de competencia. |
language | Language | ✅ | Idioma. |
keywords? | string[] | ⬜️ | Palabras clave relacionadas. |
LocationItem
| Prop | Tipo | Req. | Descripción |
|---|---|---|---|
city | string | ✅ | Ciudad. |
address? | string | ⬜️ | Dirección. |
country? | Country | ⬜️ | País. |
postalCode? | string | ⬜️ | Código postal. |
region? | string | ⬜️ | Región/provincia/estado. |
ProfileItem
| Prop | Tipo | Req. | Descripción |
|---|---|---|---|
network | Network | ✅ | Red o plataforma. |
username | string | ✅ | Usuario. |
url? | string | ⬜️ | URL del perfil. |
ProjectItem
| Prop | Tipo | Req. | Descripción |
|---|---|---|---|
name | string | ✅ | Nombre. |
startDate | string | ✅ | Inicio. |
summary | string | ✅ | Logros/detalles. |
description? | string | ⬜️ | Descripción. |
endDate? | string | ⬜️ | Fin. |
keywords? | string[] | ⬜️ | Tecnologías/keywords. |
url? | string | ⬜️ | Enlace (repo/demo). |
PublicationItem
| Prop | Tipo | Req. | Descripción |
|---|---|---|---|
name | string | ✅ | Título de la publicación. |
publisher | string | ✅ | Editorial. |
releaseDate? | string | ⬜️ | Fecha de publicación. |
summary? | string | ⬜️ | Resumen/abstract. |
url? | string | ⬜️ | Enlace (DOI/u otro). |
ReferenceItem
| Prop | Tipo | Req. | Descripción |
|---|---|---|---|
name | string | ✅ | Nombre de la referencia. |
summary | string | ✅ | Nota breve. |
email? | string | ⬜️ | Email. |
phone? | string | ⬜️ | Teléfono. |
relationship? | string | ⬜️ | Relación (p. ej., "Manager"). |
SkillItem
| Prop | Tipo | Req. | Descripción |
|---|---|---|---|
level | Level | ✅ | Nivel de la habilidad. |
name | string | ✅ | Nombre de la habilidad. |
keywords? | string[] | ⬜️ | Palabras clave relacionadas. |
VolunteerItem
| Prop | Tipo | Req. | Descripción |
|---|---|---|---|
organization | string | ✅ | Organización. |
position | string | ✅ | Rol/posición. |
startDate | string | ✅ | Inicio. |
summary | string | ✅ | Responsabilidades/logros. |
endDate? | string | ⬜️ | Fin. |
url? | string | ⬜️ | Enlace relacionado. |
WorkItem
| Prop | Tipo | Req. | Descripción |
|---|---|---|---|
name | string | ✅ | Empresa. |
position | string | ✅ | Puesto. |
startDate | string | ✅ | Inicio. |
summary | string | ✅ | Resumen de responsabilidades/logros. |
endDate? | string | ⬜️ | Fin. |
keywords? | string[] | ⬜️ | Palabras clave/tecnologías. |
url? | string | ⬜️ | Enlace relacionado. |
Locale
Define la configuración de localización para internacionalización.
| Prop | Tipo | Requerido | Descripción |
|---|---|---|---|
language? | LocaleLanguage | ⬜️ | Idioma del currículum. |
Layouts
Array de configuraciones de layout soportando múltiples formatos de salida.
| Prop | Tipo | Requerido | Descripción |
|---|---|---|---|
layouts[] | DocxLayout | HtmlLayout | LatexLayout | MarkdownLayout | TypstLayout | ⬜️ | Configuraciones de layout. |
Tipos de Layout Comunes
Margins
Define los márgenes de página para el documento.
| Prop | Tipo | Requerido | Descripción |
|---|---|---|---|
top? | string | ⬜️ | Margen superior. |
bottom? | string | ⬜️ | Margen inferior. |
left? | string | ⬜️ | Margen izquierdo. |
right? | string | ⬜️ | Margen derecho. |
Sections
Define alias de secciones para personalizar nombres.
| Prop | Tipo | Requerido | Descripción |
|---|---|---|---|
aliases? | Record<SectionID, string> | ⬜️ | Alias personalizados para nombres de secciones. |
order? | OrderableSectionID[] | ⬜️ | Orden personalizado para secciones en la salida final. |
Theme
Define la configuración visual del tema para el currículo, como los colores de acento. El motor markdown ignora la opción de tema.
| Prop | Tipo | Requerido | Descripción |
|---|---|---|---|
colors? | { accent?: AccentColor | HexColor } | ⬜️ | Define la configuración de colores del tema. |
La opción colors.accent define el color de acento de los elementos
destacados, como títulos de secciones, filetes, enlaces y etiquetas. Acepta
un preajuste con nombre de AccentColor o una cadena de
color hexadecimal #RRGGBB arbitraria.
HtmlLayout
Configuración de layout HTML.
| Prop | Tipo | Requerido | Descripción |
|---|---|---|---|
engine | 'html' | ✅ | Motor para generar el currículum. |
advanced? | HtmlAdvanced | ⬜️ | Configuración avanzada del layout. |
sections? | Sections | ⬜️ | Configuración de secciones. |
template? | HtmlTemplate | ⬜️ | Plantilla seleccionada. |
theme? | Theme | ⬜️ | Configuración visual del tema. |
typography? | HtmlTypography | ⬜️ | Configuración tipográfica. |
HtmlAdvanced
Define opciones de configuración avanzada para HTML.
| Prop | Tipo | Requerido | Descripción |
|---|---|---|---|
showAnchors? | boolean | ⬜️ | Si se emiten atributos de fragmento id en secciones y entradas para la navegación por anclas (predeterminado: true). |
showIcons? | boolean | ⬜️ | Indica si se deben mostrar iconos para enlaces y perfiles. |
title? | string | ⬜️ | Título personalizado para el documento HTML. |
footer? | string | ⬜️ | Pie de página personalizado para el document HTML. |
description? | string | ⬜️ | Meta descripción para el documento HTML. |
keywords? | string | ⬜️ | Meta palabras clave para el documento HTML. |
HtmlTypography
Define opciones tipográficas para formato de documento HTML.
| Prop | Tipo | Requerido | Descripción |
|---|---|---|---|
fontFamily? | string | ⬜️ | Una lista de familias de fuentes separada por comas. |
fontSize? | HtmlFontSize | ⬜️ | Tamaño base de fuente para el doc. |
lineSpacing? | LineSpacing | ⬜️ | Espaciado de línea para el documento. |
links? | { underline?: boolean } | ⬜️ | Configuración de estilo de enlaces. |
LatexLayout
Configuración de layout LaTeX.
| Prop | Tipo | Requerido | Descripción |
|---|---|---|---|
advanced? | LatexAdvanced | ⬜️ | Configuración avanzada. |
engine | 'latex' | ✅ | Motor para generar el currículum. |
page? | LatexPage | ⬜️ | Configuración a nivel de página. |
sections? | Sections | ⬜️ | Configuración de secciones. |
template? | LatexTemplate | ⬜️ | Plantilla seleccionada. |
theme? | Theme | ⬜️ | Configuración visual del tema. |
typography? | LatexTypography | ⬜️ | Configuración tipográfica. |
LatexAdvanced
Define opciones de configuración avanzada para LaTeX.
| Prop | Tipo | Requerido | Descripción |
|---|---|---|---|
fontspec? | { numbers?: LatexFontspecNumbers } | ⬜️ | Configuración de paquete fontspec. |
showIcons? | boolean | ⬜️ | Indica si se deben mostrar iconos para enlaces y perfiles. |
showUrls? | boolean | ⬜️ | Indica si se deben mostrar las URL en bruto u ocultarlas detrás de un texto razonable. |
LatexPage
Define opciones a nivel de página para LaTeX.
| Prop | Tipo | Requerido | Descripción |
|---|---|---|---|
margins? | Margins | ⬜️ | Márgenes de página. |
paperSize? | PaperSize | ⬜️ | Define el tamaño de papel. |
showPageNumbers? | boolean | ⬜️ | Mostrar números de página. |
LatexTypography
Define opciones tipográficas para LaTeX.
| Prop | Tipo | Requerido | Descripción |
|---|---|---|---|
fontSize? | LatexFontSize | ⬜️ | Tamaño base de fuente. |
fontFamily? | string | ⬜️ | Una lista de familias de fuentes separada por comas. |
lineSpacing? | LineSpacing | ⬜️ | Espaciado de línea para el documento. |
links? | { underline?: boolean } | ⬜️ | Estilo de enlaces. |
TypstLayout
Configuración de layout Typst.
| Prop | Tipo | Requerido | Descripción |
|---|---|---|---|
engine | 'typst' | ✅ | Motor para generar el currículum. |
advanced? | TypstAdvanced | ⬜️ | Define opciones de configuración avanzada. |
page? | TypstPage | ⬜️ | Define la configuración a nivel de página para la presentación del documento. |
sections? | Sections | ⬜️ | Define la configuración de personalización de secciones. |
template? | TypstTemplate | ⬜️ | Define la plantilla seleccionada. |
theme? | Theme | ⬜️ | Define la configuración visual del tema del currículum. |
typography? | TypstTypography | ⬜️ | Define la configuración tipográfica para el formato del documento. |
TypstAdvanced
Define opciones de configuración avanzada de Typst.
| Prop | Tipo | Requerido | Descripción |
|---|---|---|---|
showIcons? | boolean | ⬜️ | Indica si se deben mostrar iconos para enlaces y perfiles. |
showUrls? | boolean | ⬜️ | Indica si se deben mostrar las URL en bruto u ocultarlas detrás de un texto razonable. |
TypstPage
Define la configuración a nivel de página de Typst para la presentación del documento.
| Prop | Tipo | Requerido | Descripción |
|---|---|---|---|
margins? | Margins | ⬜️ | Define los márgenes de página. |
paperSize? | TypstPaperSize | ⬜️ | Define el tamaño de papel. |
showPageNumbers? | boolean | ⬜️ | Indica si se deben mostrar los números de página. |
TypstTypography
Define la configuración tipográfica de Typst para el formato del documento.
| Prop | Tipo | Requerido | Descripción |
|---|---|---|---|
fontSize? | TypstFontSize | ⬜️ | Tamaño base de fuente para el documento. |
fontFamily? | string | ⬜️ | Una lista de familias de fuentes separada por comas. |
lineSpacing? | LineSpacing | ⬜️ | Espaciado de línea para el documento. |
links? | { underline?: boolean } | ⬜️ | Configuración de estilo de enlaces. |
MarkdownLayout
Configuración de layout Markdown.
| Prop | Tipo | Requerido | Descripción |
|---|---|---|---|
engine | 'markdown' | ✅ | Motor para generar el currículum. |
sections? | Sections | ⬜️ | Configuración de secciones. |
DocxLayout
Configuración de layout DOCX.
| Prop | Tipo | Requerido | Descripción |
|---|---|---|---|
engine | 'docx' | ✅ | Motor para generar el currículum. |
advanced? | DocxAdvanced | ⬜️ | Opciones de configuración avanzada. |
page? | DocxPage | ⬜️ | Configuración a nivel de página. |
sections? | Sections | ⬜️ | Configuración de secciones. |
template? | DocxTemplate | ⬜️ | Plantilla seleccionada. |
theme? | Theme | ⬜️ | Configuración visual del tema. |
typography? | DocxTypography | ⬜️ | Configuración tipográfica. |
DocxAdvanced
Opciones de configuración avanzada para DOCX.
| Prop | Tipo | Requerido | Descripción |
|---|---|---|---|
showIcons? | boolean | ⬜️ | Indica si se deben mostrar iconos para enlaces y perfiles. |
showUrls? | boolean | ⬜️ | Indica si se deben mostrar las URL en bruto u ocultarlas detrás de un texto razonable. |
DocxPage
Configuración a nivel de página para DOCX.
| Prop | Tipo | Requerido | Descripción |
|---|---|---|---|
margins? | Margins | ⬜️ | Márgenes de página. |
paperSize? | DocxPaperSize | ⬜️ | Define el tamaño de papel. |
showPageNumbers? | boolean | ⬜️ | Mostrar números de página. |
DocxTypography
Configuración tipográfica para DOCX.
| Prop | Tipo | Requerido | Descripción |
|---|---|---|---|
fontSize? | DocxFontSize | ⬜️ | Tamaño base de fuente. |
fontFamily? | string | ⬜️ | Una lista de familias de fuentes separada por comas. |
lineSpacing? | LineSpacing | ⬜️ | Espaciado de línea para el documento. |
links? | { underline?: boolean } | ⬜️ | Estilo de enlaces. |
Tipos de enumeración
Enums de Contenido
Country
Tipo unión que incluye todos los posibles países y regiones del mundo.
Degree
Tipo unión que incluye todos los posibles grados académicos.
AssociateBachelorDiplomaDoctorHigh SchoolMasterMiddle School
Fluency
Tipo unión que incluye todos los posibles niveles de competencia lingüística.
Elementary ProficiencyFull Professional ProficiencyLimited Working ProficiencyMinimum Professional ProficiencyNative or Bilingual Proficiency
Language
Tipo unión que incluye todos los idiomas soportados.
Level
Tipo unión que incluye todos los posibles niveles de dominio de habilidades.
AdvancedBeginnerExpertIntermediateMasterNovice
Network
Tipo unión que incluye todas las posibles opciones de redes sociales.
Enums de Layout
AccentColor
Un tipo de unión para todos los preajustes de color de acento posibles, que
siguen la paleta del esquema de colores de
moderncv.
También se acepta una cadena de color hexadecimal #RRGGBB arbitraria
donde se espera un AccentColor.
black-#000000blue-#3873B3burgundy-#980000cerulean-#0081A7green-#59B24Dgrey-#737373orange-#F28C26purple-#8054CCred-#F23333
DocxFontSize
Tipo unión que incluye todas las posibles opciones de tamaño de fuente DOCX.
10pt- tamaño de fuente de 10pt (por defecto)10.5pt- tamaño de fuente de 10.5pt11pt- tamaño de fuente de 11pt11.5pt- tamaño de fuente de 11.5pt12pt- tamaño de fuente de 12pt
DocxPaperSize
Tipo unión que incluye todas las posibles opciones de tamaño de papel DOCX.
a4(por defecto)letter
DocxTemplate
Tipo unión que incluye todas las posibles opciones de plantilla DOCX.
Ver también: templates
calm
HtmlFontSize
Tipo unión opciones de tamaño de fuente HTML.
El motor HTML soporta tamaños de 14px a 20px:
14px,15px,16px(por defecto),17px,18px,19px,20px
HtmlTemplate
Tipo unión opciones de plantilla HTML.
Ver también: templates
calmkamivscode
LatexFontSize
Tipo unión que incluye todas las posibles opciones de tamaño de fuente LaTeX.
Por ahora solo se admiten 3 opciones:
10pt- tamaño de fuente de 10pt (por defecto)11pt- tamaño de fuente de 11pt12pt- tamaño de fuente de 12pt
LineSpacing
Tipo unión que incluye todas las posibles opciones de espaciado de línea.
Estos valores semánticos siguen la escala leading de Tailwind CSS:
tight- Espaciado compacto para caber más contenidosnug- Un poco más de espacio que tightnormal- Legibilidad equilibrada (por defecto)relaxed- Más espacio entre líneasloose- Diseño muy espacioso
LatexFontspecNumbers
Tipo unión que incluye todas las posibles opciones de números de fontspec de LaTeX.
Auto- permite que el estilo se determine automáticamente según elLocaleLanguageseleccionado (por defecto)Lining- cifras lining estándar (por defecto para idiomas CJK)OldStyle- cifras old style con alturas variables (por defecto para idiomas latinos)
LatexTemplate
Tipo unión que incluye todas las posibles opciones de plantilla LaTeX.
Ver también: templates
jakemoderncv-bankingmoderncv-casualmoderncv-classic
PaperSize
Tipo unión que incluye todas las posibles opciones de tamaño de papel LaTeX.
a4(por defecto)letter
TypstFontSize
Tipo unión que incluye todas las posibles opciones de tamaño de fuente Typst.
10pt- tamaño de fuente de 10pt (por defecto)11pt- tamaño de fuente de 11pt12pt- tamaño de fuente de 12pt
TypstPaperSize
Tipo unión que incluye todas las posibles opciones de tamaño de papel Typst.
a4(por defecto)letter
TypstTemplate
Tipo unión que incluye todas las posibles opciones de plantilla Typst.
Ver también: templates
jake
Enums de Localización
LocaleLanguage
Tipo unión que incluye todos los posibles códigos de lenguaje local.
Ver también: multi-languages
deenesfriditjanlnopt-brzh-hanszh-hant-hkzh-hant-tw
Last updated on