Skip to content

Latest commit

 

History

History
116 lines (89 loc) · 2.61 KB

CONTRIBUTING-KR.md

File metadata and controls

116 lines (89 loc) · 2.61 KB

문서 가이드 및 기여

프로젝트 전체 기여 가이드 참고

목차

  1. 웹사이트 구조
  2. 페이지별 내용
  3. 기술 스택
  4. 콘텐츠 관리
  5. 다국어 지원
  6. 개발 로드맵
  7. 참고 사항

1. 웹사이트 구조

/
├── 랜딩 페이지
├── 문서 (Docs)
├── 블로그 (Blog)
├── 쇼케이스 (Showcase)
└── [기타 페이지들]

2. 페이지별 내용

2.1 랜딩 페이지

  • 프로젝트 소개
  • 주요 기능 하이라이트
  • Notion으로 블로그 셀프 호스팅 가이드 (튜토리얼 형식)
  • 시작하기 버튼 (문서로 연결)

2.2 문서 (Docs)

+------------------+
|    Sidebar       |
|  - 카테고리 1    |
|    - 문서 1      |
|    - 문서 2      |
|  - 카테고리 2    |
|    - 문서 3      |
|    - 문서 4      |
+------------------+
|                  |
|    Content       |
|                  |
|  [문서 내용]     |
|                  |
+------------------+

2.3 블로그 (Blog)

  • 개발 과정, 업데이트, 팁 등의 포스트
  • 태그 및 날짜별 정렬 기능

2.4 쇼케이스 (Showcase)

  • 사용자들의 커스텀 Notion 페이지 전시
  • 필터링 및 정렬 기능

3. 기술 스택

  • Frontend: Next.js
  • CSS: TailwindCSS
  • UI 라이브러리: Radix UI 또는 Acenti/UI (필요시 사용)
  • 마크다운 렌더링: Next.js 공식 문서 참고

4. 콘텐츠 관리

4.1 문서 (Docs)

  • 위치: /content/docs/[lang]/[category]/[document].md
  • Frontmatter:
    • group: 카테고리
    • order: 문서 순서
    • title: 문서 제목
    • description: 문서 설명

4.2 블로그 (Blog)

  • 위치: /content/blog/[lang]/[post].md
  • Frontmatter:
    • title: 포스트 제목
    • description: 포스트 설명
    • date: 작성일

5. 다국어 지원

  • 지원 언어: 한국어(kr), 영어(en), 중국어(cn)
  • 마크다운 파일: 언어별로 분리 관리
  • UI 텍스트: 다국어 지원 라이브러리 사용

6. 개발 로드맵

  1. 기본 Next.js 프로젝트 설정
  2. TailwindCSS 통합
  3. 마크다운 렌더링 시스템 구축
  4. 다국어 지원 시스템 구현
  5. 랜딩 페이지 개발
  6. 문서 페이지 개발
  7. 블로그 페이지 개발
  8. 쇼케이스 페이지 개발
  9. UI/UX 개선 및 최적화
  10. 콘텐츠 작성 및 번역
  11. 베타 테스트 및 피드백 수집
  12. 공식 런칭

7. 참고 사항

  • 문서와 블로그 포스트는 마크다운 형식으로 관리
  • 랜딩 페이지는 Notionpresso 라이브러리를 활용한 실제 예시 포함
  • 지속적인 콘텐츠 업데이트 및 커뮤니티 참여 독려