@yamlresume/samples

@yamlresume/samples est le package qui alimente les exemples de CV sélectionnés dans YAMLResume. Il fournit un catalogue d'exemples de CV pour des postes courants — tels que ingénieur logiciel, analyste de données, data scientist, product manager et UX designer — chacun traduit en 12 langues locales.

Il est également utilisé par la commande yamlresume new --sample et la sous-commande yamlresume samples list.

Utilisation

Installez le package :

$ npm install @yamlresume/samples

Puis interrogez le catalogue d'exemples de CV par programmation :

import {
  getSampleResume,
  listSampleResumeCategories,
  listSampleResumeTags,
  listSampleResumes,
  listSampleResumesByCategory,
  listSampleResumesByLanguage,
  listSampleResumesByTag,
} from '@yamlresume/samples'

// List all sample resumes
const samples = listSampleResumes()

// List sample resumes that support a given locale language
const chineseSamples = listSampleResumesByLanguage('zh-hans')

// Filter by category or tag (case-insensitive)
const engineering = listSampleResumesByCategory('Engineering')
const pythonSamples = listSampleResumesByTag('python')

// List all unique categories and tags, sorted alphabetically
const categories = listSampleResumeCategories()
const tags = listSampleResumeTags()

// Load the raw YAML content of a sample resume
const yaml = getSampleResume('software-engineer', 'en')

Chaque entrée d'exemple de CV contient des métadonnées riches :

{
  id: 'software-engineer',
  title: 'Software Engineer',
  position: 'software engineer',
  category: 'Engineering',
  tags: ['full-stack', 'web-development', ...],
  description: '...',
  languages: ['de', 'en', 'es', ...],
  contents: {
    en: '# yaml-language-server: $schema=...',
    'zh-hans': '# yaml-language-server: $schema=...',
    ...
  }
}

API de requête

Function	Description
`listSampleResumes()`	List all available sample resumes
`listSampleResumesByLanguage(language)`	List sample resumes supporting a locale language
`listSampleResumesByCategory(category)`	List sample resumes in a category (case-insensitive)
`listSampleResumesByTag(tag)`	List sample resumes having a tag (case-insensitive)
`listSampleResumeCategories()`	List all unique categories, sorted
`listSampleResumeTags()`	List all unique tags, sorted
`getSampleResume(id, language)`	Get the raw YAML string of a sample resume

getSampleResume lève une erreur lorsque l'identifiant de l'exemple n'existe pas ou lorsque la langue demandée n'est pas disponible pour cet exemple.

Utilisation

API de requête

On this page