본문 바로가기

테크니컬 라이팅

도큐사우루스에 문서 추가하기 (3)

반응형

폴더에 따라 페이지와 문서가 구분

이전 "페이지 추가하기"를 설명하면서 가장 큰 차이는 사이드바를 가지는지 여부라고 했는데 그 외에도 하단 페이징 영역이라든지 버전 관리 지원 등의 차이가 있습니다.

문서를 추가하는 방법은 페이지와 같습니다. 다만 어느 폴더에 파일을 만드는지에 따라 달라집니다.

페이지는 "src/pages"라는 폴더에 넣고 해당 도메인 루트에서 접근을 했는데 문서는 "docs" 폴더에 넣습니다. 그리고 접근할 때도 domain.com/docs/hello 이런 식으로 docs/ 경로 아래로 접근하게 됩니다.

 

사이드바

사이드바는 docs 폴더에 있는 파일 기준으로 자동 생성됩니다(기본 옵션이 그렇게 되어 있습니다).

루트에 있는 sidebars.js 파일을 보면 자동으로 설정되어 있는 코드를 확인할 수 있습니다.

 

 

사이드바가 보이지 않아요

화면 너비에 따라 특정 너비 이하로 브라우저 크기가 줄어들면 사이드바가 감추어진 상태로 표시됩니다. 왼쪽 상단에 줄 세 개 있는 이미지(Hamburger button 이라고 합니다. 자세한 건 위키피디아 링크를 참고하세요)를 클릭하면 사이드바가 표시됩니다.

https://en.wikipedia.org/wiki/Hamburger_button

 

 

프런트 매터(Front matter)

프런트 매터는 출판에서 본문을 제외한 속표지, 머리말, 차례 등을 의미합니다. 콘텐츠를 읽는데 큰 영향을 주지 않지만 여러가지 도움을 주는 영역이라고 할 수 있죠. 마찬가지로 문서 파일에서도 여러 설정이 필요할 때 이를 프런트 매터 영역에 설정합니다. 전문(前文), 말머리 등으로 번역하는데 여기에서는 그냥 프런트 매터로 설명합니다(관련 속성이나 뭐 그런 것들 설명할 때 애매하게 번역해놓으면 곤란하더라구요).

마크다운 파일에서는 그냥 파일 맨 위에 "-" 표시를 3개 하고 시작하고 끝날 때도 "-" 표시를 3개 하는 것으로 끝냅니다.

 

 

일부 에디터(groomIDE 에디터 포함)에서는 프런트 매터 영역의 코드 강조 표시가 애매하게 처리되는데 신경쓰지 마세요.

 

 

 

 

728x90