Porównaj i porównaj lekkie języki znaczników [zamknięte]

90

Proszę zidentyfikować najpopularniejsze lekkie języki znaczników i porównać ich mocne i słabe strony. Te języki powinny być znacznikami ogólnego przeznaczenia w prozie technicznej, takiej jak dokumentacja (na przykład Haml się nie liczy).

Zobacz także: Markdown a ReStructuredText

documentation markdown markup restructuredtext textile JasonSmith
źródło
1
Zobacz także superuser.com/questions/209897/text-formatter-tools/…
RedGrittyBrick

Odpowiedzi:

115

Znam trzy główne języki używane powszechnie w większej społeczności programistycznej i technicznej: Textile, Markdown i reStructuredText. Wszystkich trzech można się nauczyć w ciągu kilku godzin lub "uskrzydlonych" z pobliską ściągawką.

Włókienniczy

  • Używany przez Redmine i społeczność Ruby
  • 113 pytań aktualnie oznaczonych na Stack Overflow
  • Najbardziej podobne do HTML, ale najmniej czytelne źródło
  • Najłatwiejsze zagnieżdżone listy wszystkich trzech języków
  • Niezrozumiałe dla nie-programistów lub nie znających języka HTML
  • Idealny do złożonych, krótkich dokumentów (z linkami, zagnieżdżonymi listami, kodem, niestandardowym HTML); na przykład: krótka dokumentacja, poradniki, zawartość bloga lub CMS
  • Odniesienie do składni

Obniżka cen

  • Wygląda na to, że nie ma „społeczności” w języku ojczystym, ale ...
  • 1274 pytania otagowane na przepełnieniu stosu *
  • Podkreśla czytelność kodu źródłowego, podobnie jak w przypadku tradycyjnych wiadomości e-mail
  • Proste osadzanie HTML (wystarczy wpisać tagi)
  • Nie ma możliwości tworzenia tabel poza osadzeniem HTML
  • Wiesz to już, jeśli znasz przepełnienie stosu
  • Łatwy do nauczenia, jeśli znasz już reStructuredText
  • Automatyczne zaciemnianie adresu e-mail dla formatu <[email protected]> (z nawiasami ostrymi)
  • Odniesienie do składni

reStructuredText (AKA ReST)

  • Popularne w społeczności Pythona
  • 285 pytań otagowanych na Stack Overflow
  • Trochę wytrwałe w kwestii białych znaków i wyrównania, jeśli o mnie chodzi
  • Listy (szczególnie listy zagnieżdżone) i akapity zawsze wydają się być w walce
  • Czytelne dla nie programistów
  • Jedyny format, który może zbudować spis treści (poprzez rozszerzenie w implementacji referencyjnej Pythona)
  • Bezpośrednio konwertuje do innych formatów, takich jak PDF i XML
  • Idealny do dużych dokumentów z dużą ilością prozy (np. Alternatywa dla docbooka dla instrukcji obsługi)
  • Odniesienie do składni
JasonSmith
źródło
4
Dla użytkowników ReST, sphinx.pocoo.org wygląda jak bardzo ładne narzędzie do dużych zbiorów dokumentacji referencyjnej o strukturze drzewiastej.
bendin
6
Nie mam żadnego problemu z listami i akapitami w reStructuredText, kiedy mocno zawijam rzeczy w Emacsie. W rzeczywistości działają dokładnie tak, jak bym się tego spodziewał :-)
Martin Geisler
1
Istnieją rozszerzenia Markdown, które pozwalają na tworzenie tabel w ASCII.
Jakub Narębski
1
ReST ma również doskonałą obsługę narzędzi: Np. Oparty na przeglądarce notex.ch jest dobrym narzędziem do eksperymentowania, uczenia się i używania ReST (w oparciu o backend sphinx.pocoo.org).
hsk81
31

Możesz również rozważyć asciidoc

  • stosunkowo czytelne znaczniki
  • proste użycie wiersza poleceń
  • niektórzy mogą postrzegać ją jako stosunkowo „wybredną” (w porównaniu z elastyczną) pod względem składni
  • docbook i (x) wyjście html
dat
źródło
2
Niestety asciidoc ma okropną składnię dla elementów listy z wieloma akapitami: musisz je oddzielić pojedynczą linią zawierającą tylko znak plus (tak, „+”).
Martin Geisler
4
@Martin: Czy elementy listy z wieloma akapitami są naprawdę takie ważne? Jeśli potrzebujesz więcej niż jednego akapitu, czy nagłówki / sekcje nie byłyby bardziej odpowiednie niż lista?
Steve S,
Największą zaletą AsciiDoc jest to, że obsługuje znacznie więcej funkcji. Może tworzyć książki, mieć sekcje ze wskazówkami, wiele wyników ... powerman.name/doc/asciidoc
Wernight
21

Strona Wikipedii dotycząca lekkich języków znaczników zawiera dobre porównanie różnych opcji, a także pokazuje składnię dla typowych zastosowań (nagłówki, pogrubienie, kursywa itp.)

technomalogiczne
źródło
5

Próbuję tutaj omówić wszystkie różne lekkie języki znaczników:

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

Jak widać, zaczęło się od „jak mogę stworzyć bezpieczny blog” - tj. Takiego, który generuje statyczny HTML, i znalazłem się w pułapce języków znaczników, systemów szablonów itp.

Aktualizacja

Skupiłem się tylko na LWML z implementacjami Pythona, a one są tutaj:

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

Do tej pory wypróbowałem Markdown i ReST, i to drugie podoba mi się bardziej z wyjątkiem fragmentów HTML osadzonych na innych stronach. Tabele, odsyłacze, linki pośrednie itp.

Travis H.
źródło
4

do dokumentacji? co powiesz na doxygen ?
Użyłem go do niektórych projektów c / c ++, które muszę udokumentować. Nawet ty możesz go „nadużywać”, tak jak autor doxygen używa do dokumentacji doxygen

mhd
źródło