메인 컨텐츠로 이동
Version: 2.0.0-beta.9

문서 개요

문서 기능을 사용해 계층 구조 내에서 사용자는 마크다운 파일을 작성할 수 있습니다.

info

전체 옵션 목록은 문서 플러그인 API 레퍼런스 문서를 참고하세요.

문서 ID

모든 문서는 유일한 id를 가집니다. 기본적으로 문서 id는 루트 디렉터리에 상대 경로로 표시되는 (확장자를 제외한)문서 이름과 같습니다.

예를 들어 greeting.md 문서의 id는 greeting입니다. 그리고 guide/hello.md 문서의 id is guide/hello입니다.

website # 사이트 루트 디렉터리
└── docs
   ├── greeting.md
└── guide
└── hello.md

id마지막에 오는 항목은 사용자가 프런트 매터에서 설정할 수도 있습니다. 예를 들어 guide/hello.md 문서에서 아래와 같이 프런트 매터를 정의했다면 idguide/part1이 됩니다.

---
id: part1
---
Lorem ipsum

문서 URL의 마지막에 오는 항목을 좀 더 조작하고 싶다면 slug(기본값은 id와 같습니다)를 추가할 수도 있습니다.

---
id: part1
slug: part1.html
---
Lorem ipsum
note

다음과 같이 사용할 수 있습니다.

  • 절대 경로 슬러그: slug: /mySlug, slug: /...
  • 상대 경로 슬러그: slug: mySlug, slug: ./../mySlug...

홈페이지 문서

문서를 루트를 사용해 https://docusaurus.io/docs/와 같은 형식으로 접근하고 싶다면 아래와 같이 슬러그를 설정합니다.

---
id: my-home-doc
slug: /
---
Lorem ipsum

문서 전용 모드

문서 기능만 필요한 경우 랜딩 페이지 없이 도큐사우루스 2를 실행할 수 있습니다. 대신 여러분의 문서 페이지는 인덱스 페이지를 보여줍니다.

문서 전용 모드로 사용하려면 문서 플러그인에서 routeBasePath: '/'를 설정하고 인덱스 페이지로 사용할 문서의 프런트 매터에 slug: /를 설정합니다(홈페이지 문서를 참고하세요).

caution

./src/pages/index.js에서 기존 홈페이지를 삭제해야 합니다. 그렇지 않으면 두 개의 파일이 같은 경로에 연결됩니다.

tip

도큐사우루스 2의 블로그 기능만 사용하고자 할 때는 "블로그 전용 모드"를 적용할 수 있습니다. 문서 전용 모드와 비슷한 방법을 적용합니다. 블로그 전용 모드에서 안내하는 설치 절차를 참고하세요.