문서화

문서화

React live ?

chakra 개발자들도 전부 sandpack로 통일시키려 했는데 디자인이나, 로딩 이슈 같은게 있어서

간단한 예제 -> react-live
복잡한 예제 -> sandpack
이렇게 쓰기로 결론

https://github.com/chakra-ui/chakra-ui-docs/pull/791 (opens in a new tab)

원하는 기능

  • mdx로 콘텐츠 관리 >> 편함
  • sandpack, react-live 수정 가능한 실시간 프리뷰
    • 자동 타입 지원이 되면 베스트, props 테스트하기 편함
    • playground 느낌으로 사용 가능
  • 현재 보고 있는 문서와 연관된 컴포넌트를 명시하면 좋겠음Pasted image 20230921145438.png
  • 사용 예시와 props설명 문서를 분리하여 관리, props 항목이 많거나 자세한 설명이 필요한 경우에 유용 https://primereact.org/checkbox/ (opens in a new tab)
  • 여러 버전의 디자인시스템 문서를 동시에 볼 수 있게 (버전이 늘어난다면 필요?) ex) ds.estsecurity.com/docs/1.1.2/components/button ds.estsecurity.com/docs/2.1.1/components/button
  • 사용되는 언어 표시 UI Pasted image 20230921145203.png