Generazione di file di aiuto per vim

8

Attualmente scrivo la mia documentazione direttamente come file di aiuto di vim. A volte ho bisogno di generare altri formati (es. PDF). Il mio flusso di lavoro consiste nel copiare il contenuto dei file della guida e trasformarli in qualcosa di cui ho bisogno. Questo è un lavoro piuttosto noioso, dal momento che per lo più devo aggiungere ulteriore markup.

Mi piace l'approccio di Markdown, che può (ad es. Usare Pandoc) trasformarsi in una varietà di formati di output. Sfortunatamente non file di aiuto di vim. Sto cercando un convertitore che utilizza un formato di input standard (ad es. XML, Markdown, testo ricostruito, testo semplice, ...) e genera un file di aiuto di VIM . O c'è qualche altro mezzo per generare automaticamente file di aiuto di vim senza scrivere un tale convertitore da solo?

vim

— Marco
fonte

Probabilmente potresti riunire un foglio di stile XSLT in poche ore.

— Ignacio Vazquez-Abrams,

11

Ci scusiamo per aver resuscitato un thread molto vecchio. Sono l'autore della mkd2vimdocsceneggiatura dietro il primo link suggerito in precedenza da lornix . Recentemente ho riscritto mkd2vimdocda zero come html2vimdoc . Supporta ancora Markdown come formato di input; convertirà Markdown in HTML e quindi convertirà quell'HTML in un file di aiuto di Vim. L'attenzione durante la riscrittura era sul supporto per una più ampia gamma di documenti di input.

Il nuovo script viene utilizzato da me stesso e da molti altri autori di plug-in, quindi è sicuramente destinato all'uso generale. Se vuoi provarlo di nuovo, mi piacerebbe sapere se ora funziona meglio per i documenti su cui vuoi usarlo. Se il problema persiste, sentiti libero di creare un problema su GitHub.

— Xolox
fonte

3

Benvenuto in SuperUser! Rispondere alle vecchie domande è apprezzato qui, alcune persone potrebbero ancora cercare risposte su quelle ed è bene migliorare quelle vecchie.

— gronostaj,

4

Ho trovato questo script, che l'autore ha creato per convertire markdown in documentazione vim. Sembra molto vicino a quello che stai cercando.

Mentre questo script di vim.org ( github repo ) converte il markdown in quello che sembra quasi tutto MA vimdoc. (sospiro) Così vicino ... forse una leggera modifica?

— lornix
fonte

Il primo script è inutilizzabile per uso generale. Potrebbe funzionare per lo stile di markup degli autori, ma non ha convertito correttamente uno dei miei file di markdown (validi). La seconda opzione è pandoc, un convertitore molto capace che mi piace molto. Sfortunatamente, non supporta vimhelp. Ho chiesto alla mailing list di aggiungere supporto, ma la risposta è stata che vimhelp non è un formato di output per scopi generici, ma un formato specializzato destinato alla documentazione di Vim, in contrasto con gli altri formati supportati. Comunque, grazie mille per il suggerimento.

— Marco

Sono curioso di sapere cosa potrebbe comportare la creazione di un convertitore da markdown a vimdoc, dal momento che la maggior parte di vimdoc è formattazione e caratteri marker speciali, mentre la magia è fatta dal comando helptags e dal vim help viewer stesso. Certo, potrei mettermi il piede in bocca (di nuovo!) ... forse dipende dalla complessità del tuo markdown iniziale.

— lornix,

Una soluzione intelligente suggerita nella mailing list era quella di creare vimhelp che è anche markdown valido. Lo svantaggio è che il markdown è un po 'ingombro di sintassi vim e i file vimhelp non obbediscono alle convenzioni di formattazione. Ma a parte questo è utilizzabile.

— Marco