Resume Next.js: TypeDoc

Introduce

• 누구나 예쁜 웹 이력서를 쉽게 만들 수 있어 (약간의 코딩으로..)
• Next.js, Bootstrap CSS 가 사용되었다.
• 사실 https://github.com/uyu423/resume-legacy 를 Next.js 로 포팅한 것.
• Sample: https://uyu423.github.io/resume-nextjs
  • 더 많은 예제는 EXAMPLE.md 를 참고한다.

Contributors

• Yowu (uyu423)
• Dal-ya
• Taeyeong Kim (lizard-kim)
• Taeyang Jin (heli-os)
• Hyogeun Oh (Zerohertz)

Requirements

• Node.js > 18
  • Node.js 18 버전 이상부터 발생하는 ERR_OSSL_EVP_UNSUPPORTED 이슈를 회피하기 위해 NODE_OPTIONS=--openssl-legacy-provider 옵션이 적용되어 있습니다.
  • 가급적 Node.js 버전 18 이상에서 테스트하기를 권장하며 가급적 .nvmrc 에 기재된 Node.js 버전 사용을 권고합니다.

Install

# fork to your github account & git cloning your forked repository
npm install

Run Development Mode

npm run dev

Structure

• asset/
  • images, favicon
• component/
  • React Components
• pages/
  • index.html 을 렌더링하기 위한 하나의 페이지 뿐이다.
• payload/
  • Payload 데이터 변경만으로 개인 웹 이력서를 뽑아낼 수 있다.
  • 이력서 렌더링에 필요한 데이터가 포함된다.
  • 하단의 Payload Detail 참고
• docs/
  • npm run export (next export) 를 실행하면 Static HTML 이 렌더링되어 docs 디렉토리 하단에 생성된다.
  • Github Pages 의 master branch 의 docs/ 디렉토리를 지정하여 Github Pages 호스팅을 할 수 있는데, 이를 위해 export 디렉토리 이름을 docs 로 명명했다.
  • docs/typedoc/ 에는 TypeDoc HTML 이 포함되지만 npm run export 로는 생성하지 않는다. npm run typedoc 으로 TypeDoc 을 생성할 수 있다.

Payload Description

• TypeDoc: https://uyu423.github.io/resume-nextjs/typedoc
  • TypeDoc 내에 모든 Payload 에 대한 Rendering Sample Screenshot 이 포함되어 있습니다.
• _global, footer Payload 을 제외한 모든 Payload 에는 disable?: boolean 필드가 존재합니다. 해당 필드가 true 면 해당 Payload 의 Section 을 렌더링하지 않습니다.

Profile

• 프로필 사진, 이름, 연락수단, 약간의 공지사항 영역
• TypeDoc: IProfile.Payload
• TS Sample: payload/profile.ts

Introduce

• 자기 소개 영역
• TypeDoc: IIntroduce.Payload
• TS Sample: payload/introduce.ts

Skill

• 본인 보유 기술에 대한 소개 영역
• TypeDoc: ISkill.Payload
• TS Sample: payload/skill.ts

Experience

• (직장)경험에 대한 소개 영역
• TypeDoc: IExperience.Payload
• TS Sample: payload/experience.ts

Project

• 수행 프로젝트에 대한 소개 영역
• TypeDoc: IProject.Payload
• TS Sample: payload/project.ts

Open Source

• 오픈소스 활동에 대한 소개 영역
• TypeDoc: IOpenSource.Payload
• TS Sample: payload/openSource.ts

Presentation

• 발표 활동에 대한 소개 영역
• TypeDoc: IPresentation.Payload
• TS Sample: payload/presentation.ts

Article

• 블로그/SNS 포스트, 기사에 대한 소개 영역
• TypeDoc: IArticle.Payload
• TS Sample: payload/article.ts

Education

• 학업에 대한 소개 영역
• TypeDoc: IEducation.Payload
• TS Sample: payload/education.ts

ETC

• 기타 항목(대회, 자격증, 봉사 등)에 대한 소개 영역
• TypeDoc: IEtc.Payload
• TS Sample: payload/etc.ts

_Global

• 전역 설정(Web Title, SEO, favicon 등)에 대한 설정 영역
• TypeDoc: IGlobal.Payload
• TS Sample: payload/_global.ts

Export

npm run export

• /docs 하위에 Static HTML 리소스가 생성된다.
• Sub Path 가지는 도메인 구조일 경우 (ex. https://uyu423.github.io/resume 로 호스팅) package.json 내의 homepage 필드 값을 호스팅 원하는 도메인으로 변경한다.
  • homepage 필드에 pathname 이 있을 경우 next.config.js 의 assetPrefix 추가하는 로직이 있음

Export to Github Pages

Repository Setting

• Options - Github Pages - Source - master branch /docs folder 를 선택
  • Github Pages Source 에 대한 자세한 내용은 help.github.com 을 참고한다.
• npm run export 를 실행하여 docs 내 Static HTML 을 갱신한다.
• 외부 도메인이 있는 경우 Custom Domain 항목에 기입한다.
  • Github Pages Hosting 에 필요한 docs/CNAME 파일은 npm run export 과정에서 자동으로 생성됩니다.
  • docs/CNAME 파일 생성에는 package.json 내 homepage 필드를 참고합니다. Custom Domain 사용시 homepage 값을 수정해주세요.
  • package.json 내 homepage 필드가 *.github.io/* 로 추정될 경우 Custom Domain 을 사용하지 않는 것으로 간주하고 docs/CNAME을 생성하지 않습니다.
  • 외부 도메인에 대한 자세한 내용은 help.github.com 를 참고한다.
• *.github.io 도메인을 그대로 사용하는 경우 http://{username}.github.io/{repository_name} 접속하면 웹 이력서가 나타난다.

Contribution

• If you want additional features, please pull request. Always open.

Question?

• production 빌드에서 이미지가 깨지는 경우
  • see https://github.com/uyu423/resume-nextjs/issues/24
• Section 의 순서는 어떻게 조절하나요?
  • 현재는 pages/index.tsx 에서 직접 렌더링 순서를 변경하는 수 밖에 없습니다.
  • 데이터나 _global payload 로 핸들링하는 방법을 고민 중입니다.
• index.html 에서 이미지, CSS가 404 발생하는 경우
  • https://github.com/uyu423/resume-nextjs/issues/37 참고