본문 바로가기

테크니컬 라이팅

도큐사우루스에서 블로그 운영하기 (5)

반응형

개인이 문서 도구를 사용할 때는 대부분 개인 블로그를 운영하기 위한 경우가 많습니다. 네이버 블로그를 써도 되지만 뭔가 자유롭지 못하고 티스토리나 워드프레스는 어느 정도 수정을 할 수 있지만 그럼에도 제약이 있어서 불편합니다.

물론 도큐사우루스 같은 문서 도구를 사용하더라도 원하는 대로 꾸미려면 많은 수고가 필요해서 대부분 기본 템플릿 정도로만 사용하긴 합니다만~ (뭐 정 마음에 들지 않으면 직접 개발해야죠~).

 

기본 템플릿에서 블로그 만들기는 간단합니다. 사실 이미 만들어져 있고 그냥 새로운 포스트만 추가하는 겁니다.

blog 폴더 아래에 YYYY-MM-DD-제목 형식으로 파일명을 만들면 끝입니다. 파일명에 있는 날짜를 기준으로 새로운 글이 추가되고 화면에 표시됩니다.

 

끝.

 

날짜 폴더에서 블로그 포스트 관리하기

매번 YYYY-MM-DD 형식을 파일명에 넣는 것이 귀찮거나 뭔가 체계적으로 관리하고 싶다면 날짜 형식에 따라 폴더를 만들고 그 안에 파일을 넣으면 됩니다. 예를 들어 2022년 6월 폴더를 만들고 그 안에 파일을 만들면 이런 식입니다.

 

 

그럼 도큐사우루스가 알아서 22-test.md 파일을 2022-06-22-test.md 파일로 처리해줍니다.

 

 

프런트 매터 정보를 아무것도 설정하지 않으면 딱 제목(파일명)과 날짜만 표시됩니다.

블로그 프런트 매터에서는 제목(title), 설명(description), slug, 작성자(authors), 태그(tags), 커버 이미지(image) 등을 설정할 수 있습니다.

 

인덱스 페이지에서 요약문만 보여주기

인덱스 페이지에서는 작성한 글 전체를 보여주는데 중간에 <!--truncate--> 를 사용하면 보여주고 싶은 부분만 표시할 수 있습니다. 예를 들어 아래와 같이 작성한 경우

 

축하합니다. 첫 번째 블로그 포스트를 작성했습니다.

<!--truncate-->

뭐 이게 다입니다.

인덱스 페이지에서는 첫 번째 줄만 표시되고 나머지 줄은 표시되지 않습니다. "Read More" 링크를 클릭해 해당 포스트 본문으로 이동해야 전체 내용을 볼 수 있습니다. 내용이 긴 경우에 유용할 듯합니다.

 

 일반적인 블로그에서는 일정 숫자만큼 알아서 잘라주기 때문에 원하지 않는 부분에서 내용이 잘리는 경우도 있습니다. 티스토리 같은 경우에도(테마에 따라 다를지는 모르겠습니다) 그냥 줄 바꿈 다 날려버리고 일정 위치에서 글자를 잘라버립니다.

 

 

작성자 정보

작성자 정보는 프런트 매터에서 작성하는데 자주 사용하는 작성자 정보는 authors.yml 파일에 저장해놓고 해당 값을 불러올 수 있습니다. 블로그를 팀으로 운영하는 경우에는 여러 명의 작성자 정보를 노출할 수도 있습니다. 딱히 숫자 제한은 없는 것 같네요.

 

 

블로그 전용 모드

블로그 전용 모드는 base 경로를 blog로 설정해주는 겁니다. src/pages/index.js 가 아닌 블로그 포스트 목록이 사이트 접근 시 바로 표시되도록 할 수 있습니다. 다른 문서 없이 블로그만 운영하는 경우에 유용하겠죠.

가이드 문서에서는 presets 항목에서 docs:false, blog: {routeBasePath: '/'} 으로만 설정해주면 된다고 하는데 이렇게 하고 실행하면 무슨 플러그인 오류가 발생합니다.

 

에러 메시지만으로는 어떻게 처리해야 할지 몰라서 검색을 해보았더니 다행히 최근에 비슷한 오류를 이슈로 등록한 건이 있더라구요.

https://github.com/facebook/docusaurus/issues/7575

 

테마 쪽에서 상단 메뉴바에 doc 항목이 포함되어 있어서 이 부분이 오류를 일으키는 것이라고 합니다. 그래서 아래 노란 부분을 주석으로 처리해주면 문제가 해결됩니다.

 

메뉴바에서 문서 관련 링크가 사라지고 블로그 링크만 남아 있습니다.

 

좀 더 자세한 내용은 블로그 가이드 문서를 참고하세요.

https://docusaurus.io/ko/docs/blog

https://docusaurus.io/ko/docs/api/plugins/@docusaurus/plugin-content-blog

 

728x90