Bandingkan dan kontraskan bahasa markup ringan [tertutup]

90

Harap identifikasi bahasa markup ringan yang paling populer dan bandingkan kekuatan dan kelemahannya. Bahasa ini harus markup tujuan umum untuk prosa teknis, seperti untuk dokumentasi (misalnya, Haml tidak dihitung).

Lihat juga: Markdown versus ReStructuredText

documentation markdown markup restructuredtext textile JasonSmith
sumber
1
Lihat juga superuser.com/questions/209897/text-formatter-tools/…
RedGrittyBrick

Jawaban:

115

Saya mengetahui tiga bahasa utama yang biasa digunakan dalam komunitas pemrograman dan teknologi yang lebih besar: Tekstil, Penurunan Harga, dan Teks Ulang. Ketiganya bisa dipelajari dalam beberapa jam atau "bersayap" dengan lembar contekan di dekatnya.

Tekstil

  • Digunakan oleh Redmine dan komunitas Ruby
  • 113 pertanyaan saat ini diberi tag di Stack Overflow
  • Paling mirip dengan HTML, tetapi sumbernya paling tidak dapat dibaca
  • Daftar bersarang termudah dari ketiga bahasa
  • Tidak bisa dimengerti oleh non-programmer atau orang-orang yang tidak mengerti HTML
  • Ideal untuk dokumen pendek yang kompleks (dengan tautan, daftar bersarang, kode, HTML khusus); misalnya: dokumentasi singkat, petunjuk, blog atau konten CMS
  • Referensi sintaks

Penurunan harga

  • Tampaknya tidak memiliki "komunitas" dalam bahasa rumah, tetapi ...
  • 1274 pertanyaan dengan tag di Stack Overflow *
  • Menekankan keterbacaan kode sumber, mirip dengan tradisi email
  • Penyematan HTML langsung (Anda cukup mengetikkan tag)
  • Tidak ada cara membuat tabel selain menyematkan HTML
  • Anda sudah mengetahuinya jika Anda tahu Stack Overflow
  • Mudah dipelajari jika Anda sudah mengetahui reStructuredText
  • Penyamaran alamat email otomatis untuk format <[email protected]> (dengan tanda kurung siku)
  • Referensi sintaks

reStructuredText (AKA ReST)

  • Populer di komunitas Python
  • 285 pertanyaan dengan tag di Stack Overflow
  • Sedikit persnickety tentang spasi dan penyelarasan jika Anda bertanya kepada saya
  • Daftar (terutama daftar bersarang) dan paragraf sepertinya selalu berkelahi
  • Dapat dibaca oleh non-programmer
  • Hanya format yang dapat membangun daftar isi (melalui ekstensi dalam implementasi referensi Python)
  • Langsung mengonversi ke format lain seperti PDF dan XML
  • Ideal untuk dokumen besar dengan banyak prosa (misalnya, alternatif untuk buku dokumen untuk panduan pengguna)
  • Referensi sintaks
JasonSmith
sumber
4
Bagi pengguna ReST, sphinx.pocoo.org terlihat seperti alat yang sangat bagus untuk koleksi dokumentasi referensi berstruktur pohon besar.
bendin
6
Saya tidak memiliki masalah dengan daftar dan paragraf di reStructuredText ketika saya membungkusnya dengan keras di Emacs. Faktanya, mereka berfungsi persis seperti yang saya harapkan :-)
Martin Geisler
1
Ada ekstensi untuk penurunan harga yang memungkinkan membuat tabel di ASCII.
Jakub Narębski
1
ReST juga memiliki dukungan alat yang sangat baik: Misalnya notex.ch berbasis browser adalah alat yang baik untuk bereksperimen, belajar dan menggunakan ReST (berdasarkan backend sphinx.pocoo.org).
hsk81
31

Anda juga dapat mempertimbangkan asciidoc

  • markup yang relatif mudah dibaca
  • penggunaan baris perintah langsung
  • beberapa mungkin melihatnya sebagai relatif 'pilih-pilih' (vs. fleksibel) sehubungan dengan sintaks
  • docbook dan (x) html keluaran
dat
sumber
2
Sayangnya asciidoc memiliki sintaks yang buruk untuk item daftar dengan banyak paragraf: Anda harus memisahkannya dengan satu baris yang hanya berisi tanda tambah (ya, "+").
Martin Geisler
4
@ Martin: Apakah item daftar multi-paragraf benar-benar penting? Jika Anda membutuhkan lebih dari satu paragraf, bukankah judul / bagian lebih sesuai daripada daftar?
Steve S
Keuntungan terbesar AsciiDoc adalah mendukung lebih banyak fitur. Itu dapat membuat buku, memiliki bagian tip, banyak keluaran ... powerman.name/doc/asciidoc
Wernight
21

Halaman Wikipedia tentang bahasa markup ringan memiliki perbandingan yang baik antara berbagai opsi, serta menampilkan sintaks untuk penggunaan umum (judul, tebal, miring, dll.)

technomalogical
sumber
5

Saya mencoba untuk mencakup semua bahasa markup ringan di sini:

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

Seperti yang Anda lihat, ini dimulai dengan "bagaimana saya bisa membuat blog yang aman" - yaitu blog yang menghasilkan HTML statis, dan saya mendapati diri saya terjerat dalam bahasa markup, sistem template, dll.

Memperbarui

Saya hanya memfokuskan kembali pada LWML dengan implementasi python, dan semuanya ada di sini:

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

Sejauh ini saya sudah mencoba penurunan harga dan ReST, dan saya lebih suka yang terakhir lebih baik untuk apa pun kecuali cuplikan HTML yang disematkan di halaman lain. Tabel, referensi silang, tautan tidak langsung, dll ...

Travis H.
sumber
4

untuk dokumentasi? bagaimana dengan doxygen ?
Saya telah menggunakannya untuk beberapa proyek c / c ++ yang perlu saya dokumentasikan. Bahkan Anda dapat 'menyalahgunakannya' seperti yang penulis doxygen gunakan untuk dokumentasi doxygen

mhd
sumber