메인 컨텐츠로 이동
버전: Canary 🚧

문서 만들기

greeting.md라는 이름으로 마크다운 파일을 만들고 docs 디렉터리에 가져다 놓습니다.

website # 사이트 루트 디렉터리
├── docs
│   └── greeting.md
├── src
│   └── pages
├── docusaurus.config.js
├── ...
---
description: Create a doc page with rich content.
---

# 안녕하세요

오픈 소스 프로젝트를 사용해 여러분의 문서 사이트를 만들 준비가 되었나요?

## 헤더

오른쪽 상단에는 목차가 표시됩니다.

목차를 통해 독자는 페이지를 스크롤하거나 문서를 다 읽지 않아도 어떤 내용이 담겨 있는지 알 수 있습니다.

## h2, h3 태그만 목차에 표시됩니다.

문서별로 또는 테마 구성에서 목차 표제 수준을 설정할 수 있습니다.

헤더가 잘 정돈되어야 계층 관계가 명확하게 보여질 수 있습니다.

- 독자가 꼭 읽어야 하는 항목은
- 목록을 사용해서
- 잘 드러나도록 할 수 있습니다.
  - 그리고 각 목록 항목은
    - 중첩해서 여러 번 표시할 수 있습니다.
참고

docs 디렉터리에서 밑줄(_)이 접두사로 붙은 모든 파일은 "불완전한" 페이지로 취급되면 기본적으로 무시됩니다.

불완전한 페이지 가져오기 항목을 참고하세요.

문서 프런트 매터​

프런트 매터는 여러분의 문서 페이지에 대한 추가적인 메타데이터를 제공하는데 사용됩니다. 프런트 매터는 선택 사항입니다. 도큐사우루스는 프런트 매터가 없어도 필요한 모든 메타데이터를 처리할 수 있습니다. For example, the doc tags feature introduced below requires using front matter. 사용할 수 있는 필드는 API 문서를 참고하세요.

문서 태그​

선택 사항으로 문서 사이드바 외 다른 차원의 분류 기능을 지원하기 위해 태그를 문서 페이지에 추가할 수 있습니다. 태그는 라벨 목록 형태로 프런트 매터에 전달됩니다.

---
id: doc-with-tags
title: A doc with tags
tags:
  - Demo
  - Getting started
---
팁

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

추가적인 내용은 Yaml array syntaxes 문서를 참고하세요.

폴더 구조 구성​

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

문서 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. Namely, if a file is named one the following, the file name won't be included in the URL:

  • index로 명명 (대소문자 구분): docs/Guides/index.md
  • README로 명명 (대소문자 구분): docs/Guides/README.mdx
  • 부모 폴더와 같은 이름으로 명명: docs/Guides/Guides.md

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

참고

This convention is exactly the same as the category index convention. However, the isCategoryIndex configuration does not affect the document URL.

문서 URL을 변경하려면 slug 프런트 매터를 사용하세요.

예를 들어 사이트 구조가 다음과 같다고 가정합니다.

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

hello.md의 기본 경로는 /docs/guide/hello가 됩니다. URL을 /docs/bonjour으로 변경할 수 있습니다.

---
slug: /bonjour
---

Lorem ipsum

slug은 기본적으로 /docs에 있는 문서 플러그인의 routeBasePath에 추가됩니다. URL에서 /docs을 제거하고 싶다면 문서 전용 모드를 참고하세요.

참고

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

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

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

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

Lorem ipsum

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

파일 시스템 구성에 대한 권장 사항은 파일 시스템이 사이드바 구조를 반영하도록 하고(sidebars.js 파일을 직접 수정할 필요가 없도록) 각 문서의 URL을 사용자 지정하기 위해 slug 프런트 매터를 사용하는 것입니다.