Skip to content

시작하기 ​

mineproj에 오신 것을 환영합니다! 이 가이드는 첫 번째 프로젝트 포트폴리오 사이트를 만드는 데 도움을 드립니다.

사전 요구사항 ​

  • Node.js 22 이상
  • pnpm 10 (npm install -g pnpm으로 설치)

새 사이트 만들기 ​

가장 빠른 시작 방법은 스캐폴딩 도구를 사용하는 것입니다:

bash
npx create-mineproj my-portfolio
cd my-portfolio
pnpm dev

브라우저에서 http://localhost:5173을 열어 사이트를 확인하세요.

프로젝트 구조 ​

my-portfolio/
├─ mineproj.config.ts      # 사이트 설정
├─ data/
│  ├─ projects/             # 프로젝트 데이터 (JSON + Markdown)
│  │  └─ my-project/
│  │     ├─ index.json      # 프로젝트 메타데이터
│  │     └─ body.md         # 프로젝트 본문 내용
│  ├─ profile.json          # 프로필 정보
│  └─ tags.json             # 태그 정의
├─ public/                  # 정적 에셋 (이미지, PDF 등)
└─ dist/                    # 빌드 출력 (생성됨)

프로젝트 추가하기 ​

data/projects/ 아래에 새 디렉터리를 생성하세요:

bash
mineproj new my-project

위 명령은 data/projects/my-project/index.json과 data/projects/my-project/body.md를 생성합니다. JSON 파일을 편집하여 프로젝트의 메타데이터를 설정하세요.

프로덕션 빌드 ​

bash
pnpm build

출력은 dist/에 생성됩니다. 로컬에서 미리보기:

bash
pnpm preview

다음 단계 ​

Released under the Apache-2.0 License.