메인 컨텐츠로 이동
Version: 2.0.0-alpha.74

개요

유의사항#

도큐사우루스 v2는 아직 알파 버전(2019년부터)입니다. 하지만 어느 정도는 안정적입니다.

도큐사우루스 v1보다는 도큐사우르스 v2를 사용하는 것을 적극 권장합니다.

리액트 네이티브, 리덕스 뿐 아니라 많은 프로젝트에서 v2를 사용하고 있습니다. (npm trend 참고)

이럴 때는 v2를 권장합니다.

  • ✅ 최신의 잼스택(Jamstack) 문서 사이트를 만들고자 할 때
  • ✅ 클라이언트 사이드 라우팅을 적용한 단일 페이지 애플리케이션(SPA)을 만들고자 할 때
  • ✅ 리액트와 MDX의 최적의 조합을 활용하고자 할 때
  • ✅ IE11 사용자는 고려하지 않아도 될 때
tip

new.docusaurus.io에 접속하면 도큐사우루스를 바로 테스트해볼 수 있습니다.

이럴 때는 도큐사우루스 v1을 사용해야 합니다.

  • ❌ 단일 페이지 애플리케이션(SPA)을 사용하고 싶지 않을 때
  • ❌ 최신의 기술보다는 안정성을 원할 때
  • ❌ IE11 사용자에 대한 지원이 필요할 때

좀 더 좋아진 도큐사우루스가 도착했습니다#

Docusaurus Slash Introduction

도큐사우루스 1은 순수하게 문서 사이트 생성을 위한 용도였습니다. 도큐사우루스 2에서는 기존 버전의 장점(쉬운 시작, 문서 버전 관리, 국제화)은 유지하면서 다양한 사용자 확장을 지원하도록 새롭게 구성했습니다.

한발 더 나아가 도큐사우루스 2는 강력한 정적 사이트 생성 기능을 지원합니다. 이를 통해 다양한 콘텐츠 기반의 웹사이트(문서, 블로그, 랜딩 사이트, 마케팅 페이지 등)를 매우 빠르게 구현할 수 있습니다.

그렇지만 여전히 주요 관심은 문서를 잘 만들고 보여주는것에 있습니다. 도큐사우루스 2는 리액트 애플리케이션으로 구현했기 때문에 다양한 형식의 웹사이트를 지원할 수 있을 뿐입니다. 이제 도큐사우루스는 문서 뿐 아니라 다양한 웹사이트를 만들 수 있습니다.

주요 기능#

도큐사우루스는 여러분이 사이트를 만들고 협업자, 기여자와 함께 문서를 만드는 경험에 많은 관심을 기울여 만들고 있습니다.

  • ⚛️ 💚을 담아 리액트로 만들었습니다
    • 리액트를 사용해 기능을 확장하거나 수정할 수 있습니다.
    • 컴포넌트 swizzling을 통해 사이트 사용자 경험을 완전히 제어할 수 있습니다.
  • 확장 기능
    • 기본 템플릿을 사용해 사이트를 만들고 사이트 또는 커뮤니티에서 만든 확장 기능을 선택해 추가할 수 있습니다.
    • 여러분이 만든 플러그인을 오픈 소스로 다른 사용자들과 공유할 수 있습니다. 공유는 사랑입니다.
  • ✂️ 개발자 경험
    • 다양한 부트스트랩 템플릿을 사용해 당장이라도 사이트를 만들고 구동해 문서 작업을 시작할 수 있습니다.
    • 통합된 설정 시작점은 유지보수를 쉽게 만들어줍니다.
    • 변경된 부분만 증분 빌드해서 번개처럼 빠르게 반영할 수 있습니다.
    • 라우트 기반으로 코드와 데이터를 분할합니다.
    • 깃허브 페이지, 네트리파이나 기타 배포 서비스에 쉽게 게시할 수 있습니다.

우리가 지향하는 목표는 여러분의 사용자가 정보를 빠르게 찾고 제품을 더 잘 이해할 수 있도록 돕는 것입니다. 도큐사우루스 1의 경험을 바탕으로 문서 사이트 구축에 필요한 최적의 방법을 공유합니다.

  • 🎯 준비된 검색엔진 최적화
    • 모든 접근할 수 있는 경로에 대한 HTML 파일을 만들어줍니다.
    • 페이지별 SEO를 통해 사용자가 당면한 문제 해결에 필요한 공식 문서에 바로 도달할 수 있도록 도와줍니다.
  • 📝 강력한 MDX 기능 활용
    • 마크다운 문서 내에 JSX와 리액트로 동적인 컴포넌트를 작성할 수 있습니다.
    • 라이브 에디터를 사용해 사용자가 즉시 코드를 실행해볼 수 있습니다.
  • 🔍 검색 - 사이트 전체를 검색할 수 있습니다.
  • 💾 문서 버전 관리 - 프로젝트 릴리스에 따라 문서 버전을 손쉽게 관리할 수 있습니다.
  • 🌍 i18n

도큐사우루스는 누구나 접근할 수 있고 다른 어떤 것보다 빠르게 보여지도록 만들었습니다.

  • ⚡️ 번개처럼 빠르게 - 도큐사우루스 2는 PRPL 패턴을 기반으로 콘텐츠를 엄청나게 빠르게 보여줄 수 있도록 구현했습니다.
  • 🦖 접근성 - 사이트에 누구나 접근할 수 있도록 접근성에도 주의를 기울이고 있습니다.

다른 도구 비교#

다른 정적인 사이트 생성 도구와 다르게 도큐사우루스는 문서 사이트에 포커스를 맞추고 있습니다. 사이트에 필요한 기본적인 구성은 바로 사용할 준비가 되어 있습니다.

아래에 주요한 정적 사이트 생성 도구와 비교한 내용을 정리했습니다.

개츠비(Gatsby)#

개츠비는 다양한 기능과 풍부한 플러그인을 통해 도큐사우루스에서 할 수 있는 대부분의 기능을 지원하고 있습니다. 하지만 개츠비를 처음 사용하기 위해서는 기능을 학습하는 시간이 좀 더 필요합니다. 개츠비는 다양한 형태의 웹사이트를 만들어야 할 때 적합한 도구입니다. 반면에 도큐사우루스는 콘텐츠를 작성하고 게시하는 일에 최적화된 도구를 만드는데 집중하고 있습니다.

그래프QL(GraphQL)은 개츠비의 핵심이기도 합니다. 물론 개츠비 사이트를 만들 때 그래프QL이 꼭 필요한 건 아닙니다. 대부분의 경우 정적인 웹사이트 구축 시에는 그래프QL이 제공하는 유연성을 필요로 하지 않습니다.

도큐사우루스 2의 많은 부분은 개츠비의 여러 기능에서 영감을 얻었고 상호 보완적인 관계라고 할 수 있습니다.

깃북(GitBook)#

깃북은 깔끔한 디자인을 가지고 있으며 많은 오픈소스 프로젝트에서 사용하고 있습니다. 하지만 오픈소스 도구보다는 상용 도구로 깃북의 관심이 옮겨지면서 오픈소스 프로젝트 문서 사이트에 필요한 요구를 더 이상 맞추어 주지 못하고 있습니다. 그래서 많은 프로젝트가 다른 도구로 이전하고 있습니다. 리덕스(Redux)도 도큐사우루스로 문서 도구를 이전했습니다. 문서 도구 관련 이슈에서 자세한 내용을 살펴볼 수 있습니다.

현재 깃북은 오픈소스와 비영리 조직에게만 무료로 제공됩니다. 하지만 도큐사우루스는 누구에게나 무료입니다.

지킬(Jekyll)#

지킬은 가장 잘 알려진 정적인 사이트 생성 도구이며 매우 좋은 도구입니다. 사실 도큐사우루스를 내놓기 전에는 페이스북의 오픈소스 웹사이트는 대부분 지킬을 사용해 만들었습니다. 지킬은 매우 간단하게 시작할 수 있습니다. 우리는 지킬에서 정적인 사이트를 개발하는 것과 유사한 개발자 경험을 제공하고자 노력하고 있습니다.

지킬에서는 정적인 HTML 파일을 만들고 <script />를 사용해 상호 작용 기능을 추가하는데 비해 도큐사우루스는 리액트 앱으로 구현할 수 있습니다. 우리는 최신의 자바스크립트 생태계 도구를 사용하면서 사이트의 성능이나 리소스 빌드 파이프라인, 최적화, 간편한 설정에 대한 새로운 표준을 제시하고자 합니다.

뷰프레스(VuePress)#

뷰프레스는 도큐사우루스와 비슷한 점이 많습니다. 둘 다 콘텐츠 기반의 사이트를 만들고 그에 필요한 기능을 제공하는데 초점을 두고 있습니다. 뷰프레스는 뷰(Vue)를 기반으로 도큐사우루스는 리액트를 기반으로 만들어졌다는 차이가 있습니다. 뷰 기반의 솔루션을 원한다면 뷰프레스가 적절한 선택일 것입니다.

최신 정보는 아래에서 확인하세요#

뭔가 부족한가요?#

문서를 읽으면서 문제를 발견하거나 문서 또는 프로젝트를 개선하기 위한 의견이 있다면 이슈로 등록하거나 @docusaurus 아이디를 포함해 트윗을 남겨주세요.

새로운 기능 요청은 Canny board에 남겨주세요. 로드맵을 위한 유용한 도구이며 추천 순으로 기능 요청 목록을 정렬할 수 있습니다. 깃헙 이슈에서는 어떤 요청에 대한 관심이 많은지 알 수 없지만, Canny board에서는 가장 많은 추천을 받은 요청을 개발 팀에서 빠르게 인지할 수 있습니다. 새로운 기능(특히 커다란 기능)은 풀 리퀘스트를 생성하지 말아주세요. 누군가 이미 만들고 있거나 로드맵의 일부일 수 있습니다. 새로운 기능이 필요하다면 우리에게 먼저 연락해주세요!