Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

47 컴포넌트 문서 관련 작업 #49

Open
wants to merge 2 commits into
base: develop
Choose a base branch
from

Conversation

jgjgill
Copy link
Member

@jgjgill jgjgill commented Oct 16, 2023

구현 내용

컴포넌트 문서화 관련 작업을 진행했습니다.

배포와 자동화까지 진행해보고 싶었는데 많은 삽질이 예상되어서 추후에 하겠습니다..
스토리북 배포 자동화와 같이 진행될 것 같네요.

  • develop 브랜치에 푸시될 때 스토리북 배포 최신화 진행
  • develop 브랜치에 푸시될 때 문서 배포 최신화 진행

스크린샷

2023-10-16.12.08.38.mov

참고 사항

실행 방법

cd docs
npm install
npm run dev

현재 off-design-system에 배포된 컴포넌트에 관한 문서만 간략하게 작성했습니다.
작성하는 방법은 components 폴더에 mdx 파일을 만들고 내용을 작성하시면 됩니다.
_meta.json에는 파일명을 받아서 사이드바에 대한 제목을 구성합니다.

궁금한 점

이슈 번호

nextra 설치 관련 작업
모듈 설정 관련 cjs로 확장자 변경
@jgjgill jgjgill added 문서 기능 새로운 기능을 개발합니다. labels Oct 16, 2023
@jgjgill jgjgill self-assigned this Oct 16, 2023
@jgjgill jgjgill linked an issue Oct 16, 2023 that may be closed by this pull request
2 tasks
@github-actions
Copy link

Copy link
Collaborator

@Lim-JiSeon Lim-JiSeon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

고생하셨습니다.
이미지 업로더 부분은 제가 좀 더 내용을 붙여서 다양한 버전의 예시를 올리도록 하겠습니다.
참고해서 아바타 컴포넌트도 추가하겠습니다!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
기능 새로운 기능을 개발합니다. 문서
Projects
None yet
Development

Successfully merging this pull request may close these issues.

컴포넌트 문서 관련 작업
2 participants