Compare e contraste as linguagens de marcação leves [fechado]

90

Identifique as linguagens de marcação leves mais populares e compare seus pontos fortes e fracos. Essas linguagens devem ser marcações de uso geral para prosa técnica, como para documentação (por exemplo, Haml não conta).

Veja também: Markdown versus ReStructuredText

documentation markdown markup restructuredtext textile JasonSmith
fonte
1
Consulte também superuser.com/questions/209897/text-formatter-tools/…
RedGrittyBrick

Respostas:

115

Conheço três linguagens principais comumente usadas na grande comunidade de programação e tecnologia: Textile, Markdown e reStructuredText. Todos os três podem ser aprendidos em algumas horas ou "alados" com a folha de dicas por perto.

Têxtil

  • Usado por Redmine e pela comunidade Ruby
  • 113 perguntas marcadas atualmente no Stack Overflow
  • O mais semelhante ao HTML, mas a fonte menos legível
  • Listas aninhadas mais fáceis de todos os três idiomas
  • Não compreensível para não programadores ou ignorantes de HTML
  • Ideal para documentos curtos complexos (com links, listas aninhadas, código, HTML personalizado); por exemplo: documentação curta, instruções, blog ou conteúdo CMS
  • Referência de sintaxe

Markdown

  • Não parece ter uma "comunidade" em sua língua materna, mas ...
  • 1274 perguntas marcadas no Stack Overflow *
  • Enfatiza a legibilidade do código-fonte, semelhante às tradições de e-mail
  • Incorporação direta de HTML (basta digitar as tags)
  • Nenhuma maneira de fazer tabelas além de incorporar HTML
  • Você já sabe se conhece Stack Overflow
  • Fácil de aprender se você já conhece reStructuredText
  • Ofuscação automática de endereço de e-mail para o formato <endereç[email protected]> (com colchetes angulares)
  • Referência de sintaxe

reStructuredText (também conhecido como ReST)

  • Popular na comunidade Python
  • 285 perguntas marcadas no Stack Overflow
  • Um pouco perspicaz sobre espaços em branco e alinhamento, se você me perguntar
  • Listas (especialmente listas aninhadas) e parágrafos sempre parecem entrar em brigas
  • Legível por não programadores
  • Somente formato que pode construir um índice (por meio de uma extensão na implementação de referência do Python)
  • Converte diretamente para outros formatos como PDF e XML
  • Ideal para documentos grandes com muita prosa (por exemplo, uma alternativa ao docbook para um manual do usuário)
  • Referência de sintaxe
JasonSmith
fonte
4
Para usuários do ReST, sphinx.pocoo.org parece uma ferramenta muito boa para grandes coleções estruturadas em árvore de documentação de referência.
encerramento de
6
Eu não tenho nenhum problema com listas e parágrafos em reStructuredText quando embrulho coisas em Emacs. Na verdade, eles funcionam exatamente como eu esperava que funcionassem :-)
Martin Geisler
1
Existem extensões para Markdown que permitem compor tabelas em ASCII.
Jakub Narębski
1
O ReST também tem um excelente suporte a ferramentas: por exemplo, o notex.ch baseado em navegador é uma boa ferramenta para experimentar, aprender e usar ReST (baseado no backend sphinx.pocoo.org).
hsk81
31

Você também pode considerar asciidoc

  • marcação relativamente legível
  • uso direto da linha de comando
  • alguns podem considerá-lo relativamente 'exigente' (vs. flexível) no que diz respeito à sintaxe
  • docbook e (x) saída html
dat
fonte
2
Infelizmente asciidoc tem uma sintaxe horrível para itens de lista com vários parágrafos: você tem que separá-los com uma única linha contendo apenas um sinal de mais (sim, um "+").
Martin Geisler
4
@Martin: Os itens da lista de vários parágrafos são realmente importantes? Se você precisar de mais de um parágrafo, os títulos / seções não seriam mais apropriados do que uma lista?
Steve S de
A maior vantagem do AsciiDoc é que ele suporta muito mais recursos. Ele pode criar livros, ter seções de dicas, muitas saídas ... powerman.name/doc/asciidoc
Wernight
21

A página da Wikipedia sobre linguagens de marcação leves tem uma boa comparação entre as várias opções, bem como mostra a sintaxe para usos comuns (cabeçalhos, negrito, itálico, etc.)

tecnomalógico
fonte
5

Estou tentando cobrir todas as várias linguagens de marcação leves aqui:

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

Como você pode ver, começou com "como posso fazer um blog seguro" - ou seja, um que gera HTML estático, e me vi preso em linguagens de marcação, sistemas de modelos, etc.

Atualizar

Eu me concentrei apenas em LWMLs com implementações python, e eles estão aqui:

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

Até agora, tentei markdown e ReST, e gosto mais do último para qualquer coisa, exceto snippets de HTML incorporados em outras páginas. Tabelas, referências cruzadas, links indiretos, etc ...

Travis H.
fonte
4

para documentação? que tal doxygen ?
Eu o usei para alguns projetos c / c ++ que preciso documentar. Até você pode 'abusar' dele, assim como o autor do doxygen usa para a documentação do doxygen

mhd
fonte