Gerando arquivos de ajuda para o vim

Question

Atualmente escrevo minha documentação diretamente como arquivos de ajuda do vim. Às vezes eu precisa gerar outros formatos (por exemplo, PDF). Meu fluxo de trabalho é copiar o conteúdo de os arquivos de ajuda e transformá-los em algo que eu preciso. Isso é muito entediante trabalho, uma vez que eu principalmente tenho que adicionar marcação adicional.

Eu gosto da abordagem do Markdown, que pode (por exemplo, usando o Pandoc) ser transformada em uma variedade de formatos de saída. Infelizmente não vim arquivos de ajuda. eu sou procurando por um conversor que usa um formato de entrada padrão (por exemplo, XML, Markdown, ReStructed Text, texto simples,…) e produzem um arquivo de ajuda vim. Ou existe algum outro meio de gerar automaticamente arquivos de ajuda do vim sem escrever um conversor?

    

Answer 1

Desculpe por ressuscitar um tópico muito antigo. Sou o autor do script mkd2vimdoc por trás do primeiro link sugerido por lornix anteriormente. Recentemente reescrevi mkd2vimdoc como html2vimdoc . Ainda suporta o Markdown como formato de entrada; Ele converterá o Markdown em HTML e, em seguida, converterá esse HTML em um arquivo de ajuda do Vim. O foco durante a reescrita foi o suporte para uma gama mais ampla de documentos de entrada.

O novo script está sendo usado por mim e por vários outros autores de plug-ins, por isso é definitivamente destinado ao uso geral. Se você quiser tentar mais uma vez, eu adoraria saber se agora funciona melhor para os documentos que você deseja usar. Se ainda assim não funcionar, sinta-se à vontade para criar um problema no GitHub.

    

Answer 2

Eu encontrei este script, que o autor criou para converter markdown em documentação do vim. Soa muito perto do que você está procurando.

Enquanto este script vim.org ( github repo ) converte markdown em algo que parece ser quase tudo, MAS vimdoc. (suspiro) Tão perto ... talvez uma ligeira modificação?