버전: 3.10.2

문서 만들기

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

website # root directory of your site
├── docs
│   └── greeting.md
├── src
│   └── pages
├── docusaurus.config.js
├── ...

---
description: Create a doc page with rich content.
---

# Hello from Docusaurus

Are you ready to create the documentation site for your open source project?

## Headers

will show up on the table of contents on the upper right

So that your users will know what this page is all about without scrolling down or even without reading too much.

## Only h2 and h3 will be in the TOC by default.

You can configure the TOC heading levels either per-document or in the theme configuration.

The headers are well-spaced so that the hierarchy is clear.

- lists will help you
- present the key points
- that you want your users to remember
  - and you may nest them
    - multiple times

참고

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

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

문서 프런트 매터

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

문서 태그

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

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

다음 예시에서:

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

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

# Title

Content

docs/tags.yml
docusaurus:
  label: 'Docusaurus'
  permalink: '/docusaurus'
  description: 'Docs related to the Docusaurus framework'

팁

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

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

폴더 구조 구성

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

문서 ID

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

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

website # Root directory of your site
└── docs
   ├── greeting.md
   └── guide
      └── hello.md

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

---
id: part1
---

Lorem ipsum

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

문서 URL

기본적으로 문서의 URL 위치는 문서 파일 경로를 기반으로 하는 문서 id에 따라 결정됩니다.

파일 이름이 다음 중 하나라면 해당 이름은 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

모든 경우에 기본 slug는 /Guides만 포함하며, /index, /README 또는 중복된 /Guides 경로 구간은 포함하지 않습니다.

참고

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

slug 프런트 매터를 사용해 문서 URL을 명시적으로 지정하고 기본 URL을 재정의하세요.

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

website # Root directory of your site
└── docs
    └── guide
        └── hello.md

기본적으로 hello.md는 /docs/guide/hello에서 볼 수 있습니다. 이 문서의 URL 위치를 /docs/bonjour로 변경할 수 있습니다:

---
slug: /bonjour
---

Lorem ipsum

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

참고

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

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

팁

문서의 파일 이름이나 id를 변경하면, 기본 URL도 변경됩니다. 파일 이름을 바꿀 때 영구 링크가 끊어지는 일을 방지하려면, URL이 바뀌지 않도록 slug를 명시적으로 설정하는 것을 권장합니다.

루트에서 문서 제공하기

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

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

Lorem ipsum

사이드바

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

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

문서 프런트 매터​

문서 태그​

폴더 구조 구성​

문서 ID​

문서 URL​

루트에서 문서 제공하기​

사이드바​