Skip to content

jhk1090/namucode

Repository files navigation

나무코드 Namucode

나무위키의 Monaco 편집기의 VSCode 확장 프로그램 버전입니다. 더 강력한 텍스트 강조, 자동완성, 문서 미리보기 등 여러 기능을 즐겨보세요!

namucode_oneditor

설치

나무코드는 Visual Studio Code 확장 프로그램으로, Visual Studio Code Marketplace에서 다운로드 가능합니다.

사용법

  1. 나무코드를 설치합니다. (상단 설치 항목 참고)
  2. 설치 후 언어칸에서 '나무마크'를 선택하거나 파일 확장자를 .namu로 바꿔줍니다.
  3. 설정이 끝났으며 나무마크 문법을 사용해보세요!
namucode_onlanguageselect
선택란

기능

텍스트 강조 기능

나무코드는 텍스트 강조(Syntax Highlighting)를 지원합니다. 나무위키의 Monaco 에디터보다 더 세세한 강조가 지원됩니다. 아래 두 사진을 비교해보세요!

namucode_origin namucode_vscode
나무위키 편집기 나무코드 편집기

미리보기

▶ 자세한 정보는 미리보기 가이드 항목을 참고하세요.

나무코드는 미리보기를 지원합니다. F1을 눌러 나무코드: 미리보기 옵션을 누르거나 *.namu 파일의 오른쪽 상단에 위치한 미리보기 아이콘을 눌러 미리보기를 조회할 수 있습니다. 미리보기 기능은 the seed 엔진을 모방한 the tree 엔진 위에서 돌아갑니다.

미리보기 기능을 위해서는 Node.js 22 이상을 필요로 합니다. 설치되지 않았다면 사용할 수 없습니다.

Image Image
미리보기 아이콘
위의 빨간색 네모로 표시된 아이콘
미리보기 예시

코드 분석 기능

나무코드는 코드 분석 기능을 지원합니다. 간단한 분석을 통해 교정할 수 있는 문법 등을 강조해 표시합니다. 현재 코드 분석을 통해 강조를 지원하는 구문은 다음과 같습니다.

  • 비권장 문법 경고 표시 - 나무위키에서 권장하지 않는 문법을 사용한 경우 경고를 표시합니다.
    • 1단계 문단 경고
  • 인용문 오류 표시 - 인용문은 8단계 이상 중첩할 수 없습니다. 만약 사용한 경우 오류를 표시합니다.

문단 자동 정렬 기능

나무코드는 문단 자동 정렬 기능을 지원합니다. F1을 눌러 나무코드: 문단 자동 정렬 옵션을 누르거나 *.namu 파일의 오른쪽 상단에 위치한 문단 자동 정렬 아이콘을 누를 경우, 자동으로 문단이 가나다 순으로 정렬됩니다.

Image
문단 자동 정렬 아이콘

자동완성 기능

나무코드는 편의를 위한 자동완성을 지원합니다. 쉽게 ctrl+space로 자동완성 목록을 볼 수 있습니다.
현재 사용할 수 있는 자동완성 목록은 다음과 같습니다.

  • child - 하위 문서 틀을 삽입합니다.
  • contentmoved - 문서 가져옴 틀을 삽입합니다.
  • detail - 상세 내용 틀을 삽입합니다.
  • detailanchor - 상세 내용 틀을 앵커와 함께 삽입합니다.
  • detailparagraph - 상세 내용 틀을 문단 번호와 함께 삽입합니다.
  • file - 파일을 삽입합니다.
  • folding - [ 펼치기 · 접기 ] 문법을 삽입합니다.
  • include, xmf - 틀을 삽입합니다.
  • link - 링크할 문서명과 문서에서 보여지는 명칭이 있는 링크를 생성합니다.
  • navertv - 네이버TV 영상을 삽입합니다.
  • parent - 상위 문서 틀을 삽입합니다.
  • relate - 관련 문서 틀을 삽입합니다.
  • youtube, yt - 유튜브 영상을 삽입합니다.
  • if - if 문법을 삽입합니다.
  • wikistyle, ws - wiki style 문법을 삽입합니다.
  • wikistyledark, wsd - wiki style 문법을 삽입합니다. (dark-style 포함)
  • syntax - 문법 강조 구문을 삽입합니다.
  • HTML - HTML 구문을 삽입합니다.
  • h<n> - <n>단계 문단을 삽입합니다.
  • h<n>f - <n>단계 접힌 문단을 삽입합니다.

커맨드 기능

여기서 커맨드는 F1시 나오는 커맨드 팔레트의 커맨드들을 지칭합니다. F1을 눌러 아래의 목록을 검색하거나 단축키를 이용하면 적용됩니다.
커맨드 목록은 다음과 같습니다.

  • 문단 한단계 높이기 ctrl(cmd)+ - 선택한 범위 내에서 문단을 한단계 높인다.
    == 개요 == → === 개요 ===
  • 문단 한단계 낮추기 ctrl(cmd)+ - 선택한 범위 내에서 문단을 한단계 낮춘다.
    === 개요 === → == 개요 ==
  • 텍스트 링크 ctrl(cmd)+shift+K - 선택한 문자를 링크로 만든다. 선택 -> [[선택]]
  • 텍스트 굵게 ctrl(cmd)+B - 선택한 문자를 굵게 만든다.
  • 텍스트 기울임 ctrl(cmd)+I - 선택한 문자를 기울임꼴로 만든다.
  • 텍스트 밑줄 ctrl(cmd)+U - 선택한 문자를 밑줄로 만든다.
  • 텍스트 취소선 ctrl(cmd)+shift+D - 선택한 문자를 취소선으로 만든다.
  • 텍스트 위첨자 ctrl(cmd)+shift+U - 선택한 문자를 위첨자로 만든다.
  • 텍스트 아래첨자 ctrl(cmd)+shift+Y - 선택한 문자를 아래첨자로 만든다.
  • 문단 자동 정렬 기능 ctrl(cmd)+k ctrl(cmd)+s - 문단 자동 정렬 기능을 제공한다.
  • 미리보기 ctrl(cmd)+k ctrl(cmd)+p - 미리보기 기능을 제공한다.
  • 미리보기 설정 열기 - 미리보기에 관한 설정을 조회합니다.

목차 표시 기능

편집기 왼쪽 탐색기 탭에서 확인할 수 있으며, 문단 제목의 내용을 그대로 가져와 '개요'(outline) 란에 표시합니다.
목차 클릭시 클릭한 목차로 이동됩니다.

namucode_tableofcontent ▲ 나무위키:문법 도움말

저작권 고지

▶ 자세한 정보는 라이센스 항목을 참고하세요.

본 프로젝트는 MIT License 하에 배포됩니다.

단, 프로젝트 일부에는 정현수님의 the treethe tree frontend 프로젝트의 코드가 포함되어 있으며, 이는 원저작자의 명시적 허락을 받아 사용되었습니다. 사용 범위는 client/media/frontend의 하위 파일 및 client/media/parser의 하위 파일입니다. 해당 부분의 저작권은 원저작자에게 있습니다.

이 프로젝트에 사용된 나무위키 아이콘 저작자는 kein, 저작권은 umanle S.R.L.가 소유하고 있으며, CC BY-NC-SA 2.0 KR 하에 배포됩니다. (참고)

기여

프로젝트 발전에 기여하시는 분들을 전부 환영합니다! Pull Requests를 통해 기여해주실 수 있습니다.

이 프로젝트는 Node.js 22 이상을 필요로 합니다. 기여할 때 참고하시길 바랍니다.

업데이트 로그

업데이트 로그는 여기를 참고하세요.

참고

About

나무코드 - 나무위키 VSCode 확장 프로그램

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 2

  •  
  •