Markdown 메모 또는 인라인 주석에서 Vim 문서를 생성하거나 문서를 추가하는 더 좋은 방법이 있습니까?

이것은 하나 의 두 가지 질문입니다. 최근에 vimscript를 심층적으로 배우고 vim의 내부를 배우고 vim 플러그인을 작성하는 첫 단계를 밟는 데 많은 시간을 보냈습니다. 이 과정에서 필자는 개별 마크 다운 파일에 광범위한 메모를 보관하고 vimscript 파일에 많은 인라인 '문서'주석을 추가했습니다.

마침내 공유 할 가치가있는 코드가 생겼고 실제 문서를 추가하고 싶습니다 . 아직 내 자신의 도움말 파일을 작성하지 않았으므로 여전히 해당 프로세스를 파악하고 있습니다.

이 워크 플로에 대한 경험이 없거나 탄탄한 이해가 없으면 두 가지 작업이 있습니다.

1. vim / vimscript의 markdown 'notes'파일에서 helpdoc 파일을 생성하므로 언제든지 vim에서 쉽고 빠르게 읽고 참조 할 수 있습니다.
2. vimscript 파일에서 인라인 문서를 구문 분석하여 ( shocco 가 쉘 스크립트에서 작동 하는 방식과 유사 ) vimscript에 대한 관련 도움말을 생성합니다.

아이디어에 대한 제안이나 조언 ( 이것은 나쁜 아이디어입니다 ..., 더 나은 아이디어는 ... ) 또는 아이디어 를 달성하는 방법은 크게 감사하겠습니다.

내가 아는 한 현재 두 문제에 대한 좋은 해결책은 없지만 많은 사람들이 문제 해결에 관심이 있습니다.

Markdown은 HTML의 상위 집합이므로 markdown에서 Vim 도움말로의 변환에 대한 정면 접근 방식이 성공하지 못할 것이라고 말합니다. Haskell을 말할 수 있다면 pandoc에 대한 Vim 도움말 백엔드를 작성할 수 있습니다. 완벽하지 않더라도 아주 좋은 해결책이 될 것입니다.

다른 방법으로 Vim 도움말 페이지를 유용한 형식으로 변환하려고 시도했습니다. HTML 및 PDF 버전의 공식 도움말을 생성하는 다양한 스크립트가 있으며, 다양한 정도의 성공을 거두고 있습니다. 그러나 그들은 모두 다소 동질적인 스타일의 도움에 의존합니다. 판독과 같은 것에 대한 Vim 도움말 독자조차도 가치있는 프로젝트 일 것입니다.

Vim 코드에서 문서를 추출 할 때 vimlparser라는 Python, JavaScript 및 VimL 자체의 VimL 파서가 있습니다. VimL 소스를 구문 분석하고 특수하게 조작 된 주석을 덤프하는 것을 작성하는 것은 어렵지 않습니다. 이러한 주석을 POD 와 같은 것으로 변환 할 수 있으면 매우 유용 할 것입니다.

html2vimdoc.py

내가 찾은 가장 유망한 도구는 http://peterodding.com/code/vim/tools 및 githubhtml2vimdoc.py 에서 찾을 수 있습니다 . markdown과 html을 vim의 도움말 형식으로 변환 할 수 있습니다. 보급 된 기능은 다음과 같습니다.

• [BeautifulSoup] bs 덕분에 복잡한 HTML을 처리 할 수 ​​있습니다
• 제목에 대한 Vim 도움말 파일 태그 자동 생성
• 제목 및 태그에서 목차 생성
• 중첩 된 목록, 목록 내의 사전 형식화 된 블록 등과 같은 중첩 된 블록 구조를 지원합니다.
• 목록 항목 당 평균 줄 수를 기준으로 목록 항목을 압축 및 확장합니다.

더 오래된 대안은 https://github.com/mklabs/vim-markdown-helpfile입니다.

/superuser//q/415470/generating-help-files-for-vim 에 대한 토론도있었습니다.