본문 바로가기

테크니컬 라이팅

도큐사우루스 사이드바 순서는 어떻게 정해지나 (4)

반응형

튜토리얼 기본 옵션은 자동 생성인데 새로운 파일을 추가하면 항상 기존 폴더 뒤에 생성이 됩니다. 

 

sidebar_position

그 비밀은 프런트 매터에 설정한 sidebar_position 값에 있습니다.

intro.md 파일의 sidebar_position 값이 1이라서 "Turorial Intro" 항목이 가장 먼저 표시되는 겁니다.

md 파일 내 프런트 매터 설정이 없으면 파일명 또는 폴더명 알파벳 순으로 표시됩니다.

(제목을 설정하면 사이드바에 제목이 표시되는데 그렇다고 해서 제목에 따라 순서가 달라지는 건 아니네요. 순서는 파일명을 따라갑니다).

 

* 프런트 매터에서 설정할 수 있는 값은 아래 링크를 참고하세요.

sidebar_position 속성값은 자동 생성된 사이드바 아이템의 경우 유효한 값입니다.

https://docusaurus.io/ko/docs/api/plugins/@docusaurus/plugin-content-docs#markdown-front-matter

 

📦 plugin-content-docs | Docusaurus

문서 만들기 기능을 제공하는 도큐사우루스의 기본 문서 플러그인입니다.

docusaurus.io

 

_category_.json

그럼 나머지는 폴더인데 어떻게 설정할까요?

두 개 폴더를 열어보면 md 파일이 아닌 json 파일이 하나씩 들어가 있습니다.

_category_.json 파일인데요. 이름에서 알 수 있듯이 뭔가 폴더(카테고리)의 속성을 설정하는 파일인 것을 알 수 있습니다.

tutorial-basics 폴더에 있는 파일을 열어보면 다음과 같습니다.

 

{
  "label": "Tutorial - Basics",
  "position": 2,
  "link": {
    "type": "generated-index",
    "description": "5 minutes to learn the most important Docusaurus concepts."
  }
}

 

여기에서는 position 항목에서 값을 지정할 수 있습니다.

자세한 내용은 카테고리 아이템 메타데이터 설명을 참고하세요.

https://docusaurus.io/ko/docs/sidebar/autogenerated#category-item-metadata

 

자동 생성 | Docusaurus

도큐사우루스는 여러분의 파일시스템 구조에 따라 자동으로 사이드바를 만듭니다. 각 디렉터리가 사이드바 카테고리로, 각 파일이 문서 링크로 만들어집니다.

docusaurus.io

Sidebar slice

문서가 속한 카테고리의 사이드바라고 설명하면 될까요?

예를 들어 A라는 문서가 있는데 A라는 문서가 표시될 때 같이 나타나는 사이드바를 의미합니다.

이게 여러 설정에 따라 사이드바 내 항목이 달라지는 거라서 전체 사이드바와 다르게 사이드바 슬라이스(Sidebar slice)라는 표현을 사용하고 있습니다. 우리말로 하면 "사이드바 조각"으로 번역할 수도 있지만 그럼 의미가 애매해서 그냥 사이드바 슬라이스로 표현하고 있습니다.

 

* 도큐사우루스 외에는 "Sidebar slice"라는 표현을 사용하지 않습니다. 뭔가 독자적인 표현을 만드는 무리수가 아닌가 싶네요. 다른 도구에서 이런 기능을 지원하는지는 확인해봐야겠습니다.

 

같은 문서에 접근하고 있지만 설정에 따라 표시되는 사이드바가 달라질 수 있다는 거죠.

 

728x90