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

문서 만들기

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

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

파일 첫 부분은 idtitle로 시작해야 도큐사우루스가 사이트 생성 시 적절한 파일을 찾을 수 있습니다.

---
id: greeting
title: Hello
---

## 안녕하세요

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

### 헤더

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

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

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

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

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

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

### 사용자 지정 id 헤더 {#custom-id}

`{#custom-id}` 구문을 사용해 사용자 지정 헤더 id를 설정할 수 있습니다.

브라우저에서는 아래와 같이 보여집니다.

http://localhost:3000

Hello from Docusaurus

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

헤더

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

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

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.

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

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

사용자 지정 id 헤더

With {#custom-id} 구문을 사용해 사용자 지정 헤더 id를 설정할 수 있습니다.

note

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

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

문서 태그

Optionally, you can add tags to your doc pages, which introduces another dimension of categorization in addition to the docs sidebar. 태그는 라벨 목록 형태로 프런트매터에 전달됩니다.

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

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

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