Skip to content

docs: 문서 홈·가이드 확장 및 README 간결화#17

Merged
Bori-github merged 7 commits into
mainfrom
docs/update-home-react-zpl
Apr 21, 2026
Merged

docs: 문서 홈·가이드 확장 및 README 간결화#17
Bori-github merged 7 commits into
mainfrom
docs/update-home-react-zpl

Conversation

@Bori-github

Copy link
Copy Markdown
Owner

📝 작업 내용

  • Rspress 홈(index.mdx)을 hero/features 레이아웃으로 정리하고, rspress.config.ts에 OG·Twitter 메타와 GitHub 소셜 링크를 반영했습니다.
  • Guide: Introduction 보강, react-zpl 설치·시작·컴포넌트 구조 문서 추가, react-zpl-api에 ZplLabel·Text·Line·DiagonalLine·Circle·Ellipse·QrCode API 레퍼런스를 추가했습니다.
  • 중복 안내였던 zpl-core-react-adapter.mdx를 제거하고 가이드 _meta.json 사이드바를 정리했습니다.
  • 루트 README.md는 문서 링크 중심으로 간결화했습니다(상세 API·긴 예제는 문서로 위임).
  • docs/styles/index.css에 문서용 스타일을 소규모로 추가했습니다.

🔍 변경 범위

  • apps/react-zpl - React ZPL 라이브러리
  • docs - 문서 사이트
  • tests - 테스트 코드
  • demos - 데모 애플리케이션
  • 기타 (설명 필요) — 루트 README.md

📸 스크린샷 (선택사항)

문서 홈·가이드 레이아웃이 바뀌었습니다. 스크린샷은 첨부하지 않았으며, pnpm docs:dev 또는 GitHub Pages 배포에서 확인할 수 있습니다.

📚 추가 정보

  • 라이브러리 코드·런타임 동작 변경 없음(문서·README만 수정).
  • 문서 base 경로는 기존과 동일하게 /zpl-kit/입니다.

- index.mdx frontmatter(hero, features) 기반 홈 구성
- globalStyles 추가
- 전역 title/description을 @zpl-kit에 맞게 조정
- index.mdx에 og:title·description·url 보강
- themeConfig.socialLinks로 저장소 링크 연결
- guide/_meta에 react-zpl 섹션·react-zpl-api 디렉터리
- 컴포넌트별 예시·Props 표 정리
- react-zpl 가이드로 내용 통합에 따른 중복 페이지 삭제
- 패키지 요약·한 줄 예시·프로젝트 구조·개발 스크립트 중심으로 정리
- 상세 API·zpl-core 예제·기술 스택·향후 계획은 문서로 위임
@vercel

vercel Bot commented Apr 21, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

1 Skipped Deployment
Project Deployment Actions Updated (UTC)
zpl-viewer Ignored Ignored Apr 21, 2026 6:58am

@Bori-github Bori-github self-assigned this Apr 21, 2026
@Bori-github Bori-github added the docs Improvements or additions to documentation label Apr 21, 2026
@Bori-github
Bori-github merged commit 76dd00e into main Apr 21, 2026
2 checks passed
@Bori-github
Bori-github deleted the docs/update-home-react-zpl branch July 17, 2026 07:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant