Membuat file bantuan untuk vim

8

Saat ini saya menulis dokumentasi saya secara langsung sebagai file bantuan vim. Terkadang saya perlu membuat format lain (misalnya PDF). Alur kerja saya adalah menyalin konten file bantuan dan mengubahnya menjadi sesuatu yang saya butuhkan. Ini adalah pekerjaan yang sangat membosankan, karena saya kebanyakan harus menambahkan markup tambahan.

Saya suka pendekatan Markdown, yang dapat (misalnya menggunakan Pandoc) diubah menjadi berbagai format output. Sayangnya tidak vim file bantuan. Saya mencari konverter yang mengambil format input standar (misalnya XML, Markdown, Teks yang distruktur ulang, teks biasa, ...) dan menghasilkan file bantuan vim. Atau ada cara lain untuk secara otomatis menghasilkan file bantuan vim tanpa menulis konverter seperti itu sendiri?

vim

— Marco
sumber

Anda mungkin bisa menyatukan stylesheet XSLT dalam beberapa jam.

— Ignacio Vazquez-Abrams

11

Maaf telah menghidupkan kembali utas yang sangat lama. Saya penulis mkd2vimdocskrip di balik tautan pertama yang disarankan oleh lornix sebelumnya. Saya baru-baru ini menulis ulang mkd2vimdocdari bawah ke atas sebagai html2vimdoc . Itu masih mendukung penurunan harga sebagai format input; itu akan mengonversi Markdown ke HTML dan kemudian mengonversi HTML itu ke file bantuan Vim. Fokus selama penulisan ulang adalah pada dukungan untuk berbagai input dokumen.

Script baru sedang digunakan oleh saya dan beberapa penulis plug-in lainnya sehingga pasti dimaksudkan untuk penggunaan umum. Jika Anda ingin mencobanya lagi, saya ingin mendengar jika sekarang berfungsi lebih baik untuk dokumen yang ingin Anda gunakan. Jika masih tidak berhasil, jangan ragu untuk membuat masalah di GitHub.

— xolox
sumber

3

Selamat datang di SuperUser! Menjawab pertanyaan-pertanyaan lama dihargai di sini, beberapa orang mungkin masih mencari jawaban atas pertanyaan-pertanyaan itu dan tidak masalah untuk memperbaiki yang lama.

— gronostaj

4

Saya menemukan skrip ini , yang penulis buat untuk mengubah dokumentasi penurunan harga menjadi vim. Kedengarannya sangat dekat dengan apa yang Anda cari.

Sementara skrip vim.org ini ( github repo ) mengubah markdown menjadi apa yang tampak seperti hampir semua BUT vimdoc. (menghela nafas) Begitu dekat ... mungkin sedikit modifikasi?

— lornix
sumber

Skrip pertama tidak dapat digunakan untuk penggunaan umum. Ini mungkin bekerja untuk gaya markup penulis, tetapi tidak mengkonversi satu pun dari file penurunan harga saya (valid) dengan benar. Pilihan kedua adalah pandoc, konverter yang sangat mampu yang saya suka banyak. Sayangnya, itu tidak mendukung vimhelp. Saya bertanya pada milis untuk menambahkan dukungan untuk itu, tetapi jawabannya adalah vimhelp bukan format output tujuan umum tetapi format khusus yang ditujukan untuk dokumentasi vim, berbeda dengan format yang didukung lainnya. Bagaimanapun, terima kasih banyak atas tipnya.

— Marco

Saya ingin tahu tentang apa yang mungkin diperlukan untuk membuat konverter dari markdown ke vimdoc, karena sebagian besar vimdoc adalah pemformatan dan karakter marker khusus, sementara sihir dilakukan oleh perintah helptags dan vim help viewer itu sendiri. Tentu saja, saya BISA meletakkan kaki saya di mulut saya (lagi!) ... mungkin itu tergantung pada kompleksitas penurunan harga awal Anda.

— lornix

Solusi cerdas yang disarankan pada milis adalah untuk membuat vimhelp yang juga merupakan penurunan harga yang valid. Kekurangannya adalah bahwa markdown agak berantakan dengan sintaks vim dan file vimhelp tidak mematuhi konvensi pemformatan. Tapi terlepas dari itu, itu bisa digunakan.

— Marco