설치
Docusaurus consists of a set of npm packages.
팁
**패스트트랙**에서 5분 ⏱안에 도큐사우루스를 이해할 수 있게 안내하고 있습니다!
**docusaurus.new**에 접속하면 여러분의 웹 브라우저에서 도큐사우루스를 바로 테스트해볼 수 있습니다!
요구 사항
- Node.js version 18.0 or above (which can be checked by running
node -v
). 여러 버전의 노드 설치가 필요하다면 nvm에서 관리할 수 있습니다.- Node.js 설치 시 종속성과 관련된 모든 확인란을 선택하는 것을 권장합니다.
웹사이트 프로젝트를 위한 뼈대 만들기
도큐사우루스를 설치하는 가장 쉬운 방법은 웹사이트 프로젝트를 위한 뼈대를 만들어주는 명령행 도구를 사용하는 겁니다. 새로 만든 저장소 또는 기존에 사용하던 저장소 어디든 실행할 수 있으며 프로젝트를 위한 기본 파일을 포함한 새로운 디렉터리를 만듭니다.
npx create-docusaurus@latest my-website classic
도큐사우루스 1에서 사용하던 기능을 포함해 빠르게 시작하고 싶다면 classic
템플릿을 사용하는 것을 권장합니다. classic
템플릿은 기본 문서, 블로그, 커스텀 페이지, CSS 프레임워크(다크 모드 지원)을 포함한 @docusaurus/preset-classic
을 제공합니다. classic 템플릿을 바로 적용해서 시작해볼 수 있습니다. 도큐사우루스에 익숙해지면 나중에 사용자 지정 템플릿을 반영할 수도 있습니다.
--typescript
플래그를 사용해 템플릿의 타입스크립트 변형을 사용할 수도 있습니다. 좀 더 많은 정보는 타입스크립트 지원을 참고하세요.
npx create-docusaurus@latest my-website classic --typescript
Meta-Only
메타 오픈 소스 프로젝트를 위해 도큐사우루스 웹사이트를 설정하는 경우 내부 저장소에서 이 명령을 실행하면 몇 가지 유용한 메타 관련 기본값이 제공됩니다.
scarf static-docs-bootstrap
대체할 수 있는 설치 명령
원하는 프로젝트 관리자를 사용해 새로운 프로젝트를 초기화할 수 있습니다.
- npm
- Yarn
- pnpm
npm init docusaurus
yarn create docusaurus
pnpm create docusaurus