본문 바로가기

728x90

docusaurus

(6)
도큐사우루스에서 지원하는 마크다운 기능 (6) 도큐사우루스는 기본 마크다운 명세를 지원하며 몇 가지 추가 기능을 사용할 수 있습니다. 프런트 매터 문서 URL이라든지 제목, 상세 설명 등의 메타 데이터를 처리하기 위해 YFM(YAML front matter) 형식을 지원합니다. https://assemble.io/docs/YAML-front-matter.html 사용할 수 있는 전체 필드는 plugin-content-docs 문서에서 참고할 수 있습니다. https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-content-docs#markdown-front-matter 필드 중 제목과 관련된 필드는 우선순위에 따라 적용됩니다. 기본적으로 제목은 파일명이 적용되며 그다음에는 마크다운 문서 내 # hel..
도큐사우루스에서 블로그 운영하기 (5) 개인이 문서 도구를 사용할 때는 대부분 개인 블로그를 운영하기 위한 경우가 많습니다. 네이버 블로그를 써도 되지만 뭔가 자유롭지 못하고 티스토리나 워드프레스는 어느 정도 수정을 할 수 있지만 그럼에도 제약이 있어서 불편합니다. 물론 도큐사우루스 같은 문서 도구를 사용하더라도 원하는 대로 꾸미려면 많은 수고가 필요해서 대부분 기본 템플릿 정도로만 사용하긴 합니다만~ (뭐 정 마음에 들지 않으면 직접 개발해야죠~). 기본 템플릿에서 블로그 만들기는 간단합니다. 사실 이미 만들어져 있고 그냥 새로운 포스트만 추가하는 겁니다. blog 폴더 아래에 YYYY-MM-DD-제목 형식으로 파일명을 만들면 끝입니다. 파일명에 있는 날짜를 기준으로 새로운 글이 추가되고 화면에 표시됩니다. 끝. 날짜 폴더에서 블로그 포스트..
도큐사우루스 사이드바 순서는 어떻게 정해지나 (4) 튜토리얼 기본 옵션은 자동 생성인데 새로운 파일을 추가하면 항상 기존 폴더 뒤에 생성이 됩니다. sidebar_position 그 비밀은 프런트 매터에 설정한 sidebar_position 값에 있습니다. intro.md 파일의 sidebar_position 값이 1이라서 "Turorial Intro" 항목이 가장 먼저 표시되는 겁니다. md 파일 내 프런트 매터 설정이 없으면 파일명 또는 폴더명 알파벳 순으로 표시됩니다. (제목을 설정하면 사이드바에 제목이 표시되는데 그렇다고 해서 제목에 따라 순서가 달라지는 건 아니네요. 순서는 파일명을 따라갑니다). * 프런트 매터에서 설정할 수 있는 값은 아래 링크를 참고하세요. sidebar_position 속성값은 자동 생성된 사이드바 아이템의 경우 유효한 값..
도큐사우루스에 문서 추가하기 (3) 폴더에 따라 페이지와 문서가 구분 이전 "페이지 추가하기"를 설명하면서 가장 큰 차이는 사이드바를 가지는지 여부라고 했는데 그 외에도 하단 페이징 영역이라든지 버전 관리 지원 등의 차이가 있습니다. 문서를 추가하는 방법은 페이지와 같습니다. 다만 어느 폴더에 파일을 만드는지에 따라 달라집니다. 페이지는 "src/pages"라는 폴더에 넣고 해당 도메인 루트에서 접근을 했는데 문서는 "docs" 폴더에 넣습니다. 그리고 접근할 때도 domain.com/docs/hello 이런 식으로 docs/ 경로 아래로 접근하게 됩니다. 사이드바 사이드바는 docs 폴더에 있는 파일 기준으로 자동 생성됩니다(기본 옵션이 그렇게 되어 있습니다). 루트에 있는 sidebars.js 파일을 보면 자동으로 설정되어 있는 코드를..
도큐사우루스에 페이지 추가하기 (2) 도큐사우루스 페이지와 문서 도큐사우루스에서는 문서와 페이지를 구분해서 설명합니다. 가장 큰 차이는 사이드바를 가지는지 여부입니다. 사이드바는 문서 왼쪽에 전체 목차처럼 표시되는 영역입니다. 문서는 책 형태를 표현하는 것이기 때문에 전체 목차를 가지고 있습니다. 페이지는 전단지처럼 별도의 목차 없이 한 페이지에 정보를 담습니다. 도큐사우루스에서는 이벤트 페이지처럼 문서와 직접 상관이 없는 항목들을 만들 때 페이지를 사용할 수 있다고 설명합니다. 도큐사우루스 사이트에서도 "쇼케이스"에 들어가면 사이드바가 표시되지 않습니다(점점 콘텐츠가 늘어나서 적절한 목차가 있어야 하지 않을까 싶긴 하지만). 상단에 필터가 있어서 원하는 콘텐츠를 필터링하는 기능을 제공하지만 사이드바에서 별도의 목차를 제공하지는 않습니다. ..
도큐사우루스 설치하고 튜토리얼 실행하기 (1) 지난번에는 goormIDE에서 Markdoc을 설치해보았는데요. https://koko8829.tistory.com/2290 이번에는 도큐사우루스를 다루어보겠습니다. 우선 설치하고 실행하는 것까지 진행합니다. 컨테이너 생성 및 환경 설정 도큐사우루스는 Node.js 16.14 이상 버전을 필요로 합니다(2.0.0-beta.21 기준). 때문에 goormIDE에서 컨테이너 생성 시 소프트웨어 스택은 Node.js로 선택하고 추가 모듈/패키지 항목에서 "Node.js 버전 16.x로 업데이트"를 선택해야 합니다(현재 시점에서는 16.15.1로 설치합니다). 도큐사우루스 설치 도큐사우루스 공식 문서 내 "패스트트랙"이라는 항목이 있습니다. 뭐 딱히 별 내용은 없고 최초 도큐사우루스 최신 버전을 설치하고 튜토리..

반응형