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

Open
2 tasks
jgjgill opened this issue Oct 15, 2023 · 0 comments · May be fixed by #49
Open
2 tasks

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

jgjgill opened this issue Oct 15, 2023 · 0 comments · May be fixed by #49
Assignees
Labels
기능 새로운 기능을 개발합니다. 문서

Comments

@jgjgill
Copy link
Member

jgjgill commented Oct 15, 2023

내용 설명

컴포넌트 문서와 관련된 작업을 진행합니다.
discussion #37 에 관련된 내용입니다.

여러 시행착오를 겪었는데요..

처음에는 Docusaurus로 진행하려 했는데 모듈과 관련된 에러가 발생했습니다.
현재 저희가 만든 라이브러리는 es module로 구성되어 있습니다.
그런데 Docusaurus에서 ESM에 대한 지원 작업이 이제 이루어지고 있고 v3?에서 가능한 것 같더라구요.
관련 이슈 - Support ESM config file

그래서 nextra로 진행하려고 합니다.
모노레포 방식이 아닌 docs 폴더 안에 패키지가 구성되는데요.
이곳에서 off-design-system이 설치해서 불러오는 형태가 될 것 같네요.

기존 프로젝트 경로로 문서를 연결하는 것까지 해보고 싶었는데 어려울 것 같네요.. 😇

작업 내용

  • docs 폴더 내 패키지 구성 및 관련 설정
  • 설정된 컴포넌트에 관한 기본 문서 작성

세부 작업 기간

3시간

@jgjgill jgjgill added 문서 기능 새로운 기능을 개발합니다. labels Oct 15, 2023
@jgjgill jgjgill self-assigned this Oct 15, 2023
@jgjgill jgjgill linked a pull request Oct 16, 2023 that will close this issue
@jgjgill jgjgill linked a pull request Oct 16, 2023 that will close this issue
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 a pull request may close this issue.

1 participant