Just The Docs 한글 검색 개선
작성일: 2023-06-28Prerequisite
- Jekyll Theme 로컬 환경 구축
한글 검색 이슈
로컬 환경에서 just-the-docs를 실행한 후 기능 테스트를 진행하다 한글 검색이 안되는 것을 확인했습니다ㅠ
한글 검색이 안 되는 원인을 찾아보니 just-the-docs는 전문 검색으로 lunr.js라이브러리를 사용하고 있는데, 지원하는 언어 중 한글이 존재하지 않았습니다.
Jekyll Theme을 바꿔야 하나 고민하면서 Github 이슈 창을 기웃거리는 도중, 저와 동일한 이슈에 대한 해결책을 찾았다는 댓글을 발견했습니다.
해당 저장소에 들어가서 설정을 확인해 보니 Lunr에서 공식 지원하지 않는 언어에 대해 Addon이 존재했습니다.
적용방법은 다음과 같습니다.
- lunr.ko.min.js, lunr.multi.min.js, lunr.stemmer.support.min,js를 다운받아 lunr.min.js 위치로 이동시킵니다.
- 프로젝트에서 lunr.min.js를 검색해서 import 하는 부분을 찾아 추가한 파일에 대해서 import 합니다.
.prettierignore도 추가해 주었습니다.
- 검색 처리하는 부분에
this.use(lunr.multiLanguage('en', 'ko'));코드 추가했습니다.
적용 후 한글 검색이 잘 되는 것을 확인할 수 있습니다!!
