본문으로 건너뛰기

Install

Docusaurus를 시작하는 방법은 다음과 같습니다:

설치 및 프로젝트 생성​

  1. Node.js 18.0 이상 버전이 설치되어 있어야 합니다.

  2. 터미널에서 다음 명령어를 실행하여 새 Docusaurus 프로젝트를 생성합니다:

    npx create-docusaurus@latest my-website classic

    여기서 'my-website'는 프로젝트 이름으로, 원하는 이름으로 변경할 수 있습니다.

  3. TypeScript를 사용하려면 다음과 같이 --typescript 플래그를 추가합니다:

    npx create-docusaurus@latest my-website classic --typescript

프로젝트 실행​

  1. 생성된 프로젝트 디렉토리로 이동합니다:

    cd my-website

  2. 개발 서버를 실행합니다:

    npm run start

  3. 브라우저에서 http://localhost:3000으로 접속하면 생성된 Docusaurus 사이트를 확인할 수 있습니다.

프로젝트 구조​

  • /docs/: 문서 파일들이 위치하는 디렉토리
  • /blog/: 블로그 포스트 파일들이 위치하는 디렉토리
  • /src/: 리액트 페이지나 컴포넌트를 위한 디렉토리
  • /static/: 정적 파일들을 위한 디렉토리
  • docusaurus.config.js: Docusaurus 설정 파일
  • sidebars.js: 사이드바 구조를 정의하는 파일

콘텐츠 추가 및 수정​

  • /docs/ 디렉토리에 Markdown 파일을 추가하여 새로운 문서 페이지를 만들 수 있습니다.
  • /blog/ 디렉토리에 Markdown 파일을 추가하여 새로운 블로그 포스트를 작성할 수 있습니다.
  • docusaurus.config.js 파일을 수정하여 사이트의 설정을 변경할 수 있습니다.

이제 Docusaurus를 사용하여 문서 사이트를 만들고 관리할 준비가 되었습니다. 필요에 따라 콘텐츠를 추가하고 테마를 커스터마이징하여 원하는 문서 사이트를 구축할 수 있습니다.

Citations: [1] https://docusaurus.io/docs [2] https://docusaurus.io/ko/docs/next/installation [3] https://www.youtube.com/watch?v=I-hYKNgaMmE [4] https://www.youtube.com/watch?v=2R53Y7eP45k [5] https://docusaurus.io/docs/3.3.2/installation [6] https://younho9.dev/docusaurus-manage-docs-1/ [7] https://tutorial.docusaurus.io/docs/intro/ [8] https://semaphoreci.com/blog/docusaurus [9] https://docusaurus.io/ko/docs/installation