버전: 3.5.2

문서 만들기

greeting.md라는 Markdown 파일을 만들고 docs 디렉터리에 넣으세요.

website # 사이트 루트 디렉터리
├── docs
│   └── greeting.md
├── src
│   └── pages
├── docusaurus.config.js
├── ...

---
description: 풍부한 콘텐츠를 담은 문서 페이지를 만드세요.
---

# 도큐사우루스에서 보내는 인사

오픈 소스 프로젝트의 문서 사이트를 만들 준비가 되셨나요?

## 제목

오른쪽 상단의 목차에 표시됩니다

따라서 사용자는 아래로 스크롤하거나 많은 내용을 읽지 않아도 이 페이지가 어떤 내용을 다루는지 알 수 있습니다.

## 기본적으로 목차에는 h2와 h3만 표시됩니다.

목차에 포함할 제목 수준은 문서별로 설정하거나 테마 설정에서 지정할 수 있습니다.

제목 사이의 간격이 적절해 계층 구조가 명확하게 드러납니다.

- 목록을 활용하면
- 사용자가 기억했으면 하는
- 핵심 내용을 효과적으로 전달할 수 있습니다
  - 목록을 중첩할 수도 있고
    - 여러 단계로 중첩할 수도 있습니다

참고

docs 디렉터리에서 파일 이름이 밑줄(_)로 시작하는 모든 파일은 "부분" 페이지로 취급되며 기본적으로 무시됩니다.

부분 페이지 가져오기에 대해 자세히 알아보세요.

문서 프런트 매터

프런트 매터는 문서 페이지에 추가 메타데이터를 제공하는 데 사용됩니다. 프런트 매터는 선택 사항입니다. 도큐사우루스는 프런트 매터가 없어도 필요한 모든 메타데이터를 처리할 수 있습니다. 예를 들어 아래에서 소개하는 문서 태그 기능을 사용하려면 프런트 매터가 필요합니다. 사용할 수 있는 모든 필드는 API 문서를 참조하세요.

문서 태그

태그는 프런트 매터에서 선언하며, 문서 사이드바 외에 또 다른 분류 기준을 제공합니다.

태그를 인라인으로 정의하거나, tags file(선택 사항, 일반적으로 docs/tags.yml)에 미리 선언된 태그를 참조할 수 있습니다.

다음 예시에서:

docusaurus는 docs/tags.yml에 미리 선언된 태그 키를 참조합니다
Releases는 docs/tags.yml에 존재하지 않으므로 인라인 태그입니다

docs/my-doc.md
---
tags:
  - Releases
  - docusaurus
---

# 제목

내용

docs/tags.yml
docusaurus:
  label: '도큐사우루스'
  permalink: '/docusaurus'
  description: '도큐사우루스 프레임워크 관련 문서'

팁

tags: [Demo, Getting started]로도 태그를 선언할 수 있습니다.

사용할 수 있는 모든 Yaml 배열 구문에 대해 자세히 알아보세요.

폴더 구조 구성

docs 폴더 아래에 Markdown 파일을 배치하는 방식은 도큐사우루스의 콘텐츠 생성에 여러 영향을 줄 수 있습니다. 하지만 대부분은 파일 구조에서 분리될 수 있습니다.

문서 ID

모든 문서에는 고유한 id가 있습니다. 기본적으로 문서의 id는 문서 루트 디렉터리를 기준으로 한 문서의 상대 경로(확장자 제외)입니다.

예를 들어 greeting.md의 ID는 greeting이고, guide/hello.md의 ID는 guide/hello입니다.

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

다만 id의 마지막 부분은 사용자가 프런트 매터에서 지정할 수 있습니다. 예를 들어 guide/hello.md의 내용이 아래와 같이 정의되어 있다면, 최종 id는 guide/part1입니다.

---
id: part1
---

Lorem ipsum

ID는 사이드바를 수작업으로 구성하거나 문서 관련 레이아웃 컴포넌트나 후크를 사용할 때 문서를 참조하기 위해 사용됩니다.

문서 URL

By default, a document's URL location is its file path relative to the docs folder, with a few exceptions. 파일명이 다음과 같다면 해당 파일명은 URL에 포함되지 않습니다.

Named as index (case-insensitive): docs/Guides/index.md
Named as README (case-insensitive): docs/Guides/README.mdx
Same name as parent folder: docs/Guides/Guides.md

In all cases, the default slug would only be /Guides, without the /index, /README, or duplicate /Guides segment.

참고

이 규칙은 카테고리 인덱스 규칙과 정확히 같습니다. 하지만 isCategoryIndex 설정은 문서 URL에 영향을 주지 않습니다.

Use the slug front matter to change a document's URL.

예를 들어, 사이트 구조가 다음과 같다고 가정해 보겠습니다:

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

By default hello.md will be available at /docs/guide/hello. 이 문서의 URL 위치를 /docs/bonjour로 변경할 수 있습니다:

---
slug: /bonjour
---

Lorem ipsum

slug는 문서 플러그인의 routeBasePath 뒤에 추가되며, 이 설정의 기본값은 /docs입니다. URL에서 /docs 부분을 제거하는 방법은 문서 전용 모드를 참고하세요.

참고

다음을 사용할 수 있습니다:

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

문서를 루트에서 제공하고 https://docusaurus.io/docs/ 같은 경로를 사용하려면, slug 프런트 매터를 사용할 수 있습니다:

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

Lorem ipsum

사이드바

자동 생성된 사이드바를 사용하면, 파일 구조에 따라 사이드바 구조가 결정됩니다.

파일 시스템 구성에 관한 권장 사항은 다음과 같습니다: 사이드바 구조와 일치하도록 파일 시스템을 구성하고 (그러면 sidebars.js 파일을 직접 작성하지 않아도 됩니다), slug 프런트 매터를 사용해 각 문서의 URL을 원하는 대로 설정하세요.

문서 프런트 매터​

문서 태그​

폴더 구조 구성​

문서 ID​

문서 URL​

사이드바​