YAMLResume

create-yamlresume

create-yamlresume 幫助您使用一行命令創建新的 YAMLResume 專案。

使用方法

npx create-yamlresume my-resume

# or

npm init yamlresume my-resume
pnpm create yamlresume my-resume
yarn create yamlresume my-resume
bun create yamlresume my-resume

功能

此工具將:

  1. 使用您的專案名稱創建新目錄
  2. 創建基本的 Node.js 專案結構,包括:
    • 帶有 YAMLResume 依賴和有用腳本的 package.json
    • 帶有適當排除規則的 .gitignore 文件
    • 帶有基本使用說明的 README.md
  3. 安裝所有必要的依賴
  4. 使用 yamlresume new 創建新的示例履歷文件
  5. 顯示可用命令和後續步驟

示例會話

$ pnpm create yamlresume
✔ What is your project name? … yamlresume
ℹ Using pnpm.

✔ What should your resume file be called? (without .yml extension) … resume
◐ Creating YAMLResume project in /private/tmp/yamlresume...
◐ Installing dependencies with pnpm...
Packages: +59
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Progress: resolved 59, reused 59, downloaded 0, added 59, done

dependencies:
+ yamlresume 0.7.5

Done in 4s using pnpm v10.6.3
✔ Dependencies installed successfully!
◐ Creating resume file resume.yml...
✔ Created resume.yml successfully.
◐ Initializing git repository...
hint: Using 'master' as the name for the initial branch. This default branch name
hint: is subject to change. To configure the initial branch name to use in all
hint: of your new repositories, which will suppress this warning, call:
hint:
hint:   git config --global init.defaultBranch <name>
hint:
hint: Names commonly chosen instead of 'master' are 'main', 'trunk' and
hint: 'development'. The just-created branch can be renamed via this command:
hint:
hint:   git branch -m <name>
Initialized empty Git repository in /tmp/yamlresume/.git/
✔ Git repository initialized!
[master (root-commit) 53c6210] init a new YAMLResume project
 4 files changed, 421 insertions(+)
 create mode 100644 .gitignore
 create mode 100644 README.md
 create mode 100644 package.json
 create mode 100644 resume.yml
✔ Initial commit created!

✨ Project created successfully!

Next steps:
ℹ   1. cd yamlresume
ℹ   2. Edit your resume: resume.yml
ℹ   3. Build your resume: pnpm run build
ℹ   4. Watch for changes: pnpm run dev
ℹ   5. Show all commands: pnpm run yamlresume help

Learn more:
ℹ   🏠 Homepage: https://yamlresume.dev
ℹ   📖 Documentation: https://yamlresume.dev/docs/
ℹ   🎨 Templates: https://yamlresume.dev/docs/layout/templates
ℹ   📝 Schema: https://yamlresume.dev/docs/compiler/schema

專案結構

生成的專案如下所示:

my-resume/
├── package.json          # 帶有 yamlresume 依賴的專案配置
├── .gitignore            # Git 忽略規則
├── README.md             # 專案文件
└── resume.yml            # 您的 YAML 履歷(您選擇的文件名)

可用命令

在生成的專案中,您可以運行:

  • npm run build - 將您的履歷構建為 PDF
  • npm run dev - 監聽變化並自動重新構建
  • npm run validate - 根據模式驗證您的履歷
  • npm run yamlresume - 運行 YAMLResume CLI
Edit on GitHub

Last updated on