새로운 질서 위키

도큐사우루스

도큐사우루스(Docusaurus)는 문서 웹사이트에 초점을 둔 정적 사이트 생성기다. (도큐사우루스 문서) 각 경로의 HTML을 미리 만들면서, 리액트와 브라우저 안의 페이지 전환 기능도 사용한다.

  • MDX로 마크다운 안에 상호작용하는 구성 요소를 넣을 수 있다. (도큐사우루스 문서) 설명 옆에서 값을 바꾸거나 예시를 조작하는 살아 있는 문서를 구상해볼 만하다.
  • 문서의 버전 관리와 다국어 발행을 지원한다. (도큐사우루스 문서) 수업 자료를 만든다면 작년 강의와 올해 강의의 차이를 어떻게 남길지 먼저 정해보자.
  • 지킬이나 아스트로와 비교할 때는 메뉴·문서 버전·상호작용의 필요를 따져보는 편이 좋다. 짧은 소개 페이지에도 모든 문서 관리 기능이 필요한 것은 아니다.

기타 등등

  • 공식 문서가 소개하는 MDX는 설명 사이에 리액트 구성 요소를 넣는 방법이기도 하다. 원고 속 예제가 실제로 움직일 수 있다. 출처
  • 버전 2는 버전 1을 크게 다시 작성한 결과다. 같은 제품 이름 아래에서도 제작 방식이 달라질 수 있으므로 예제를 볼 때 대상 버전을 확인할 만하다. 출처

#정적사이트생성기 #도구 #문서화