버전: 3.1.1

문서 개요

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

정보

전체 옵션 목록은 문서 플러그인 API 참조 문서에서 확인하세요.

여러분의 사이트 문서화는 가장 낮은 수준에서 가장 높은 수준까지 4가지 수준으로 구성되어 있습니다.

개별 페이지
사이드바.
버전.
플러그인 인스턴스

이 가이드에서는 다음 순서로 설명합니다: 개별 페이지를 설정하는 방법, 하나 이상의 사이드바를 만드는 방법, 버전을 만들고 관리하는 방법, 문서 플러그인 인스턴스를 여러 개 사용하는 방법.

문서 전용 모드

새롭게 초기화된 도큐사우루스 사이트 구조는 다음과 같습니다.

example.com/                                -> 생성 원본: `src/pages/index.js`

example.com/docs/intro                      -> 생성 원본: `docs/intro.md`
example.com/docs/tutorial-basics/...        -> 생성 원본: `docs/tutorial-basics/...`
...

example.com/blog/2021/08/26/welcome         -> 생성 원본: `blog/2021-08-26-welcome/index.md`
example.com/blog/2021/08/01/mdx-blog-post   -> 생성 원본: `blog/2021-08-01-mdx-blog-post.mdx`
...

모든 문서는 하위 경로 docs/에서 제공됩니다. 하지만 사이트에 문서만 있는 경우나 문서를 루트에 배치해 우선적으로 보여 주고 싶은 경우에는 어떻게 해야 할까요?

사이트 구성이 다음과 같은 경우를 생각해보죠.

docusaurus.config.js
export default {
  // ...
  presets: [
    [
      '@docusaurus/preset-classic',
      {
        docs: {
          /* docs plugin options */
        },
        blog: {
          /* blog plugin options */
        },
        // ...
      },
    ],
  ],
};

문서 전용 모드를 사용하려면 다음과 같이 변경하세요.

docusaurus.config.js
export default {
  // ...
  presets: [
    [
      '@docusaurus/preset-classic',
      {
        docs: {
          routeBasePath: '/', // 사이트 루트에서 문서 제공
          /* 기타 문서 플러그인 옵션 */
        },
        blog: false, // 선택 사항: 블로그 플러그인 비활성화
        // ...
      },
    ],
  ],
};

블로그 사용을 반드시 포기할 필요는 없고, 다른 플러그인도 마찬가지입니다; routeBasePath: '/'는 문서를 https://example.com/docs/some-doc 대신 사이트 루트에서 제공하도록 바꿀 뿐입니다: https://example.com/some-doc. 블로그를 활성화한 경우에는 여전히 blog/ 하위 경로로 접속할 수 있습니다.

다음 프런트 매터를 추가해 루트(https://example.com/)에 페이지를 배치하는 것을 잊지 마세요:

docs/intro.md
---
slug: /
---

This page will be the home page when users visit https://example.com/.

경고

문서에 slug: /를 추가해 홈페이지로 설정했다면, ./src/pages/index.js에 있는 기존 홈페이지를 삭제해야 하며, 그렇지 않으면 두 파일이 같은 경로에 매핑됩니다!

사이트 구조는 아래와 비슷하게 만들어졌을 겁니다.

example.com/                       -> 생성 원본: `docs/intro.md`
example.com/tutorial-basics/...    -> 생성 원본: `docs/tutorial-basics/...`
...

팁

도큐사우루스의 블로그 기능만 사용하고 싶은 사용자를 위한 "블로그 전용 모드"도 있습니다. 문서 전용 모드와 비슷한 방법을 적용합니다. 블로그 전용 모드의 설정 안내를 따라 해 보세요.

문서 전용 모드​

문서 전용 모드