Markdown notlarından veya satır içi yorumlardan Vim dokümanlarını nasıl oluşturabilirim veya dokümantasyon eklemenin daha iyi yolları var mı?


14

Bu tür birinde iki soru. Son zamanlarda vimscript'i derinlemesine öğrenmek, vim'in içini öğrenmek ve vim eklentileri yazmak için ilk adımımı atmak için çok zaman harcadım. Bu işlem sırasında, bireysel markdown dosyalarında kapsamlı notlar tutuyorum ve vimscript dosyalarına çok sayıda satır içi 'dokümantasyon' yorumu ekledim.

Sonunda paylaşmaya değer bir kod var gibi hissediyorum ve bazı gerçek belgeleri eklemeye başlamak istiyorum . Henüz kendi helpdoc dosyalarımı yazmadım, bu yüzden hala bu işlemi anlıyorum.

Bu iş akışıyla ilgili henüz herhangi bir deneyim veya sağlam bir anlayış olmadan, anlamaya çalıştığım iki görev var:

  1. Vim / vimscript üzerindeki markdown 'notlarım' dosyalarından helpdoc dosyaları oluşturmak, böylece vim'den istediğiniz zaman hızlı ve kolay bir şekilde okuyabilir / başvurabilirim.
  2. Vimscriptler için ilişkili yardım belgesini oluşturmak üzere satır içi belgeleri vimscript dosyalarımdan ( shocco'nun kabuk betiklerinde çalışma biçimine benzer ) ayrıştırma.

Fikirlerle ilgili herhangi bir öneri veya tavsiye ( bu kötü bir fikir çünkü ..., daha iyi bir fikir ... ) veya bunları nasıl gerçekleştireceğiniz çok takdir edilecektir.


1
Markdown'u vim'in
EvergreenTree

Yanıtlar:


7

Bildiğim kadarıyla, şu anda her iki sorun için de iyi bir çözüm yoktur, ancak birçok insan bunları çözmekle ilgilenecektir.

Markdown HTML'nin bir üst kümesidir, bu yüzden markdown'dan Vim yardımına dönüşüm için önden bir yaklaşımın başarılı olması muhtemel değildir. Haskell konuşabiliyorsanız, pandoc için bir Vim yardım arka planı yazmayı deneyebilirsiniz . Mükemmel olmasa bile bu çok güzel bir çözüm olurdu.

Bunu yapmak için birkaç deneme yapıldı, Vim yardım sayfalarını bazı faydalı biçimlere dönüştürün. Değişen derecelerde başarı ile resmi yardımın HTML ve PDF sürümlerini üreten birkaç komut dosyası vardır. Ancak hepsi, az çok homojen bir tarzda yardıma güveniyor. Pandom gibi bir şey için bir Vim yardım okuyucusu bile değerli bir proje olacaktır.

Vim kodundan belgeleri çıkarmak için, VimL için Python, JavaScript ve VimL'in kendisinde, vimlparser adlı bir ayrıştırıcı var . Oldukça iyi, VimL kaynaklarını ayrıştıran ve özel hazırlanmış yorumları döken bir şey yazmak zor olmamalı. Bu yorumları, örneğin POD gibi bir şeye dönüştürebilmek de oldukça faydalı olacaktır.


4

html2vimdoc.py

Bulduğum en umut verici aracı html2vimdoc.pyburada bulabilirsiniz hangi http://peterodding.com/code/vim/tools ve üzerinde github . Markdown ve html'yi vim'in yardım formatına dönüştürebilir. Reklamı yapılan özellikler:

  • [BeautifulSoup] bs sayesinde karmaşık HTML ile başa çıkabilir
  • Başlıklar için otomatik olarak Vim yardım dosyası etiketleri oluşturur
  • Başlıklardan ve etiketlerden içindekiler tablosu oluşturur
  • İç içe listeler, önceden biçimlendirilmiş bloklar vb. Gibi iç içe blok yapılarını destekler.
  • Liste öğelerini, liste öğesi başına ortalama satır sayısına göre sıkıştırır ve genişletir

Daha eski bir alternatif https://github.com/mklabs/vim-markdown-helpfile

Ayrıca /superuser//q/415470/generating-help-files-for-vim adresinde bir tartışma yapıldı.

Sitemizi kullandığınızda şunları okuyup anladığınızı kabul etmiş olursunuz: Çerez Politikası ve Gizlilik Politikası.
Licensed under cc by-sa 3.0 with attribution required.