Hafif biçimlendirme dillerini karşılaştırın ve karşılaştırın [kapalı]

Lütfen en popüler hafif biçimlendirme dillerini belirleyin ve bunların güçlü ve zayıf yönlerini karşılaştırın. Bu diller, dokümantasyon gibi teknik yazı için genel amaçlı işaretleme olmalıdır (örneğin, Haml sayılmaz).

Ayrıca bkz: Markdown ve ReStructuredText karşılaştırması

Daha büyük programlama ve teknoloji topluluğunda yaygın olarak kullanılan üç ana dil biliyorum: Textile, Markdown ve reStructuredText. Üçü de birkaç saat içinde öğrenilebilir veya yakındaki kopya kâğıdı ile "kanatlanarak" öğrenilebilir.

Tekstil

• Redmine ve Ruby topluluğu tarafından kullanılıyor
• Stack Overflow'da şu anda etiketlenmiş 113 soru
• HTML'ye en çok benzeyen, ancak en az okunabilen kaynak
• Üç dilin de en kolay iç içe geçmiş listeleri
• Programcı olmayanlar veya HTML konusunda bilgisiz olanlar tarafından anlaşılamaz
• Karmaşık kısa belgeler için idealdir (bağlantılar, iç içe geçmiş listeler, kod, özel HTML ile); örneğin: kısa belgeler, nasıl yapılır, blog veya CMS içeriği
• Sözdizimi referansı

Markdown

• Görünüşe göre ana dili "topluluğu" yok ama ...
• Stack Overflow'da etiketlenmiş 1274 soru *
• E-posta geleneklerine benzer şekilde kaynak kod okunabilirliğini vurgular
• Basit HTML yerleştirme (etiketleri yazmanız yeterlidir)
• HTML yerleştirmenin yanı sıra tablo yapmanın yolu yok
• Stack Overflow'u biliyorsanız bunu zaten biliyorsunuz
• ReStructuredText'i zaten biliyorsanız öğrenmesi kolay
• <Adres@example.com> biçimi için otomatik e-posta adresi gizleme (açılı ayraçlarla)
• Sözdizimi referansı

reStructuredText (AKA ReST)

• Python topluluğunda popüler
• Stack Overflow'da etiketlenen 285 soru
• Bana sorarsan boşluk ve hizalama konusunda biraz titizlik
• Listeler (özellikle iç içe geçmiş listeler) ve paragraflar her zaman kavga ediyor gibi görünüyor
• Programcı olmayanlar tarafından okunabilir
• Yalnızca bir içindekiler tablosu oluşturabilen biçim (Python referans uygulamasındaki bir uzantı aracılığıyla)
• Doğrudan PDF ve XML gibi diğer formatlara dönüştürür
• Çok sayıda düz yazı içeren büyük belgeler için idealdir (örneğin, bir kullanım kılavuzu için docbook'a bir alternatif)
• Sözdizimi referansı

Asciidoc'u da düşünebilirsiniz

• nispeten okunabilir işaretleme
• basit komut satırı kullanımı
• bazıları sözdizimi açısından onu nispeten 'seçici' (esnekliğe karşı) olarak algılayabilir
• docbook ve (x) html çıktısı

Hafif biçimlendirme dillerindeki Wikipedia sayfası , çeşitli seçenekler arasında iyi bir karşılaştırmaya sahiptir ve yaygın kullanımlar için sözdizimini (başlıklar, kalın, italik vb.)

Burada çeşitli hafif biçimlendirme dillerinin tümünü ele almaya çalışıyorum:

http://www.subspacefield.org/~travis/static_blog_generators.html

Gördüğünüz gibi, "nasıl güvenli bir blog yapabilirim" ile başladı - yani statik HTML üreten bir blog ve kendimi biçimlendirme dillerinde, şablon sistemlerinde vb. Tuzağa düşürülmüş buldum.

Güncelleme

Yalnızca python uygulamaları olan LWML'lere yeniden odaklandım ve buradalar:

http://www.subspacefield.org/~travis/python_lightweight_markup_languages.html

Şimdiye kadar markdown ve ReST'i denedim ve ikincisini diğer sayfalara gömülü HTML parçacıkları dışında her şey için daha çok seviyorum. Tablolar, çapraz referanslar, dolaylı bağlantılar vb.

dokümantasyon için? doxygen'e ne dersin ?
Belgelemem gereken bazı c / c ++ projeleri için kullanıyorum. Siz bile onu tıpkı doxygen yazarının doxygen dokümantasyonu için kullandığı gibi 'kötüye kullanabilirsiniz'