메인 컨텐츠로 이동

도큐사우루스를 소개합니다

· 18분 읽기 분량
조엘 마시(Joel Marcey)

Introducing Slash

여러분이 하나 이상의 오픈 소스 웹 사이트를 관리하는데 도움을 줄 수 있는 도큐사우루스를 소개하게 되어 무척 기쁩니다.

우리는 다음과 같은 이유로 도큐사우루스를 만들었습니다.

  1. 웹 사이트 만들기에 대한 걱정을 덜어내고 좋은 문서를 작성하는데 집중할 수 있게 합니다.
  2. 블로그, 검색, 버전 관리 등 오픈 소스 웹 사이트에 필요한 여러 기능을 지원합니다.
  3. 업데이트, 새로운 기능, 버그 수정 등의 프로젝트 관련 소식을 모두에게 한 번에 쉽게 전달할 수 있게 합니다.
  4. 마지막으로 연관된 오픈 소스 프로젝트 모두에서 일관성 있는 룩앤필을 줄 수 있습니다.

도큐사우루스는 웹 사이트 구조와 디자인에 대해 신경쓰지 않고 문서 웹 사이트를 쉽게 게시할 수 있게 설계된 도구입니다. 사용자는 마크다운으로 작성한 문서 파일과 리액트로 작성한 사용자 지정 홈페이지, 약간의 설정 파일 수정만 제공해주면 됩니다. 도큐사우루스는 기본 스타일, 사이트 서식, 간단한 문서 탐색 기능을 제공해 나머지를 책임집니다. 시작하는 것은 아주 간단합니다. 사용자는 npm 또는 yarn에서 간단한 설치 스크립트만으로 설치를 진행할 수 있으며 즉시 사용할 수 있는 예제 웹 사이트도 같이 제공됩니다.

도큐사우루스는 또한 블로그 지원, 국제화, 검색, 버전 관리처럼 웹 사이트와 문서화에 필요한 핵심 기능을 기본 지원합니다. 일부 프로젝트에서는 이런 기능을 필요로 하지 않다면 간단하게 설정 옵션을 수정해서 활성화 여부를 선택할 수 있습니다. 따로 기능 추가를 위한 작업은 필요 없습니다. 도큐사우루스에 새로운 기능이 추가되면 사용자는 간단하게 최신 버전으로 업데이트할 수 있습니다. npm 또는 yarn에서 업데이트 스크립트를 실행하고 설정 옵션만 업데이트해주면 됩니다. 새로운 기능을 추가할 때마다 웹 사이트 전체 구조를 뒤집어야 하는 일은 더는 필요하지 않습니다.

도큐사우루스의 탄생

Birth of Slash

페이스북에서 처음 오픈 소스 프로그램을 시작했을 때 많은 팀에서 운영하고 있는 오픈 소스 프로젝트를 위한 자체적인 웹 사이트를 만들었습니다. 이렇게 시작한 웹 사이트는 문서 기능 개선을 요청 받았을 때 곤란한 상황을 마주했습니다. 각자 알아서 만든 사이트였기 때문에 블로그, 일관된 탐색, 검색 등의 기능을 추가하는 것이 쉽지 않은 일이었습니다.

오픈 소스팀에서는 웹 사이트 작성 시 사용할 수 있는 지킬(Jekyll) 기반 기본 템플릿을 제공해 이런 문제를 해소하고자 했습니다. 새로운 프로젝트에서 템플릿 소스를 수동으로 저장소로 복사하고 문서를 작성하고 게시하게 권장했습니다. 템플릿을 사용한 접근 방식은 새로 공개하는 오픈 소스 프로젝트 대부분에 적용했습니다. 일부 기존 프로젝트에서 사용했던 사용자 지정 웹 사이트도 새로운 템플릿으로 전환하도록 했습니다.

"템플릿을 저장소에 복사하는" 접근 방식의 문제점은 일관성 있는 플랫폼을 제공했지만 템플릿을 사용하고 있는 전체 프로젝트에서 템플릿 업데이트를 반영하기 쉽지 않다는 겁니다. 템플릿이 일단 저장소에 복사되면 더 이상 중앙에서 제어할 수 없기 때문이죠. 프로젝트에서 템플릿을 필요에 따라 수정할 수도 있고 자체적인 기능을 추가하기도 했습니다. 때문에 각 프로젝트가 사이트 생성 플랫폼을 공유했지만 시간이 지나면서 템플릿에 새로운 기능을 추가해도 이를 활용할 수 없게 파편화되었습니다. 새로운 버전의 템플릿을 현재 프로젝트에 "복사"하면 기존 사이트가 훼손되거나 자체적으로 추가한 기능을 사용할 수 없게 되어 그렇게 할 수도 없었습니다. 대신 각 프로젝트에서 하나하나 수작업으로 변경된 것을 반영해야 했습니다. 하지만 이런 것도 템플릿에 국제화 지원을 요청 받았을 때는 더 이상 건드릴 수 없는 상태가 되었고 템플릿의 구조와 생성 방식을 많이 뜯어 고쳐야 하는 상황이 됐습니다.

그래서 우리는 관리하는 사이트를 업데이트하고 일관성 있게 유지하는 문제에 대해 고민하기 시작했습니다. 또한 여러 프로젝트가 같은 사이트 생성 도구를 공유하기를 원했습니다. 같은 템플릿으로 시작하더라도 필요에 따라 사이트 테마를 수정하고 적용할 수 있는 유연성을 제공하고자 했습니다. 사이트를 확장하거나 수정할 수 있어야 하지만 버그 수정이나 기능 추가를 위한 플랫폼을 업데이트 시에는 사이트에 영향을 미치지 않고 간단하게 업데이트할 수 있어야 합니다.

그래서 도큐사우루스가 탄생했습니다!

페이스북에서 도큐사우루스는 다양한 프로젝트에서 문서화 웹 사이트를 빠르게 구축하고 실행할 수 있게 합니다. 특히 웹 개발 경험이 부족하거나 그들의 프로젝트를 간단한 사이트 형태로 보여주고자 할 때 활용할 수 있습니다. 도큐사우루스는 Jest의 국제화나 리액티 네이티브의 버전 관리 같은 고급 기능을 기본 제공합니다. 특정 사이트에서 새로운 기능을 요청하면 도큐사우루스에 추가되고 동시에 모든 프로젝트에 제공됩니다! 이를 통해 프로젝트마다 사이트가 달라지면서 발생하는 유지 보수 비용을 크게 줄일 수 있습니다. 우리 팀은 기능을 추가하고 버그를 해결하고 문서를 작성하는데 초점을 맞추고 프로젝트가 원활하게 돌아가도록 할 수 있습니다.

지금 시작해서 실행해보기

Slash Up and Running

도큐사우루스는 간단하게 사용할 수 있도록 만드는 것이 가장 중요하게 신경 쓴 부분이었습니다. 하나의 설치 명령과 약간의 설정만으로 기본 구성된 웹 사이트를 만날 수 있습니다.

docusaurus-init 명령을 실행하면 아래와 같은 구조가 만들어집니다.

root-of-repo
├── docs-examples-from-docusaurus
│ ├── doc1.md
│ ├── doc2.md
│ ├── doc3.md
│ ├── exampledoc4.md
│ └── exampledoc5.md
├── website
│ ├── blog-examples-from-docusaurus
│ │ ├── 2016-03-11-blog-post.md
│ │ └── 2017-04-10-blog-post-two.md
│ ├── core
│ │ └── Footer.js
│ ├── node_modules
│ ├── package.json
│ ├── pages
│ ├── sidebars.json
│ ├── siteConfig.js
│ └── static

node_modules와 package.json를 제외한 모든 디렉터리와 파일은 도큐사우루스로 만든 사이트에 여러분이 내용을 수정하거나 새로운 파일을 추가할 수 있습니다. docs 디렉터리는 문서 마크다운 파일을 추가하는 곳입니다. blog 디렉터리에는 블로그 포스트를 위한 마크다운 파일을 추가합니다. siteConfig.js에서는 여러분의 사이트를 원하는 형태로 수정할 수 있습니다. sidebars.json에서는 문서에 사이드바를 추가하고 레이아웃과 내용을 수정할 수 있습니다. pages 디렉터리는 여러분의 사이트에 맞춤 페이지를 추가할 때 사용합니다. static 디렉터리에서는 정적 애셋(예를 들면 CSS 스타일 시트나 이미지)을 관리하고 core 디렉터리에서는 바닥글 같은 사이트의 주요 컴포넌트를 관리할 수 있습니다.

도큐사우루스는 어떻게 동작하나요?

도큐사우루스는 자바스크립트와 리액트로 작성했습니다. 이전 템플릿에서 우리가 사용하던 지킬(Jekyll)을 대체합니다. 마크다운 렌더링을 위해 Remarkable을 사용하고 코드 블록 구문 강조를 위해서는 highlight.js를 사용합니다. 도큐사우루스의 구현 코드는 도큐사우루스 저장소lib 디렉터리에서 확인할 수 있습니다. 기본 구조는 아래와 같습니다.

root-of-Docusaurus
├── lib
│ ├── core
│ ├── server
│ │ ├── generate.js
│ │ ├── server.js
│ │ └── ...and more files
│ ├── static
│ ├── build-files.js
│ ├── copy-examples.js
│ ├── generate-feed.js
│ ├── publish-gh-pages.js
│ ├── rename-version.js
│ ├── start-server.js
│ ├── versions.js
│ └── write-translations.js

가장 중요한 파일은 build-files.js와 start-server.js입니다. 두 개 파일은 서로 비슷한 점이 많습니다. build-files.js는 외부 웹 서버에 제공할 물리적 산출물을 빌드하는데 사용합니다. start-server.js는 로컬에서 여러분의 사이트를 테스트하기 위해 도큐사우루스 서버를 실행하는데 사용합니다. 둘 다 다음과 같은 순서에 따라 마크다운 파일과 설정을 확인하고 실행할 수 있는 웹 사이트를 만듭니다.

  1. siteConfig.js에 정의된 웹 사이트 설정을 처리합니다.
  2. docs 디렉터리에 있는 모든 마크다운 파일의 문서 메타데이터를 읽습니다.
  3. 메타데이터에서 추출한 ID를 기반으로 문서 목차를 만듭니다.
  4. 마크다운을 HTML로 변환합니다. 링크도 같이 변환됩니다.
  5. 만들어진 파일은 컴파일된 사이트의 build/docs 디렉터리에 위치합니다. 번역된 파일은 build/docs 디렉터리 아래에 언어별 디렉터리에 위치하게 됩니다.
  6. 블로그 포스트를 처리하기 위해 1번부터 3번까지 과정을 다시 진행합니다.
  7. 블로그 파일은 컴파일된 사이트의 build/blog 디렉터리에 위치합니다.
  8. main.css 파일을 읽어서 사용자 지정 CSS 파일을 마스터 CSS 파일에 병합하고 만든 파일은 컴파일된 사이트의 build/css 디렉터리에 위치합니다.
  9. 컴파일된 사이트 build/img 디렉터리로 이미지를 복사합니다.
  10. pages 디렉터리에 추가한 사용자 지정 페이지는 컴파일된 사이트의 루트인 build 디렉터리 아래에 컴파일되어 복사합니다. 번역된 버전 파일은 build 디렉터리 아래에 언어별 디렉터리에 위치하게 됩니다.
  11. CNAME과 sitemap.xml 파일을 만들고 추가해 빌드합니다.

위에 설명한 절차는 번역이나 버전 관리 처리에 대한 모든 과정을 포함하고 있지는 않습니다. 상세한 기능 설명은 조만간 블로그에서 공유하도록 하겠습니다.

컴파일된 사이트의 최종 구조는 아래와 같은 형태입니다.

build
├── website
│ ├── CNAME
│ ├── blog
│ ├── css
│ ├── docs
│ ├── en
│ ├── help.html # custom page
│ ├── img
│ ├── index.html # landing page
│ ├── sitemap.xml
│ └── users.html # custom page

커뮤니티

Docusaurus

우리는 도큐사우루스에 대한 여러분의 기여는 언제나 환영합니다. 여러분의 사이트에 적용할 수도 있고 원한다면 도큐사우루스 코어 기능 개발에 기여하거나 질문을 남겨주셔도 좋습니다. 깃헙트위터 팔로우도 부탁드려요.

감사의 글

도큐사우루스는 Eric Nakagawa, Hector Ramos, Eric Vicenti, Frank Li 같은 코어 개발팀의 헌신이 없었다면 나오지 못했을 겁니다. 페이스북 인턴으로 참여했었으며 핵심 기술과 기능을 구현해주었습니다.

그리고 도큐사우루스를 일찍 도입해준 분들께도 감사드립니다.

여러분들이 웹 사이트를 만들거나 이전 사이트를 이전해주지 않았다면 우리는 여기까지 오지 못했을겁니다.

리소스