比较和对比轻量级标记语言

发布于 2024-07-14 20:08:50 字数 200 浏览 10 评论 0原文

请确定最流行的轻量级标记语言并比较它们的优点和缺点。 这些语言应该是技术散文的通用标记,例如文档(例如,Haml 不算)。

另请参阅:Markdown 与 ReStructuredText

Please identify the most popular lightweight markup languages and compare their strengths and weaknesses. These languages should be general-purpose markup for technical prose, such as for documentation (for example, Haml doesn't count).

See also: Markdown versus ReStructuredText

如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。

扫码二维码加入Web技术交流群

发布评论

需要 登录 才能够评论, 你可以免费 注册 一个本站的账号。

评论(5

薄荷梦 2024-07-21 20:08:50

我知道在更大的编程和技术社区中常用的三种主要语言:Textile、Markdown 和 reStructuredText。 这三者都可以在几个小时内学会,或者通过附近的备忘单“掌握”。

Textile

  • 由 Redmine 和 Ruby 社区使用
  • 目前在 Stack Overflow 上标记了 113 个问题
  • 与 HTML 最相似,但可读性最差的源代码
  • 所有三种语言的最简单的嵌套列表
  • 非程序员或不懂 HTML 的人无法理解
  • 非常适合复杂的短文档(带有链接、嵌套列表、代码、自定义 HTML); 例如:简短的文档、操作方法、博客或 CMS 内容
  • 语法参考

Markdown

  • 不支持似乎有一个母语“社区”,但是...
  • Stack Overflow 上标记了 1274 个问题*
  • 强调源代码的可读性,类似于电子邮件
  • 传统 直接的 HTML 嵌入(您只需键入标签)
  • 除了嵌入 HTML 之外没有办法制作表格
  • 你知道如果您了解 Stack Overflow,则
  • 很容易学习 如果您已了解 reStructuredText
  • 自动电子邮件地址混淆,格式为 <[电子邮件受保护]> (带尖括号)
  • 语法参考

reStructuredText(又名 ReST)

  • 在 Python 社区中很受欢迎
  • 285 个问题标记为Stack Overflow
  • 如果你问我的话,我对空格和对齐有点挑剔
  • 列表(尤其是嵌套列表)和段落似乎总是陷入争吵
  • 非程序员可读
  • 唯一可以构建目录的格式(通过 Python 参考实现中的扩展) )
  • 直接转换为其他格式,如 PDF 和 XML
  • 非常适合包含大量散文的大型文档(例如,用户手册的 docbook 的替代品)
  • 语法参考

I know of three main languages used commonly in the greater programming and tech community: Textile, Markdown, and reStructuredText. All three can be learned in a couple of hours or "winged" with the cheat sheet nearby.

Textile

  • Used by Redmine and the Ruby community
  • 113 questions currently tagged on Stack Overflow
  • The most similar to HTML, but least readable source
  • Easiest nested lists of all three languages
  • Not understandable to non-programmers or the HTML-ignorant
  • Ideal for complex short documents (with links, nested lists, code, custom HTML); for example: short documentation, how-tos, blog or CMS content
  • Syntax reference

Markdown

  • Doesn't seem to have a home language "community" but...
  • 1274 questions tagged on Stack Overflow*
  • Emphasizes source code readability, similar to email traditions
  • Straightforward HTML embedding (you just type the tags out)
  • No way to make tables besides embedding HTML
  • You know it already if you know Stack Overflow
  • Easy to learn if you already know reStructuredText
  • Automatic email address obfuscation for the format <[email protected]> (with angle brackets)
  • Syntax reference

reStructuredText (A.K.A. ReST)

  • Popular in the Python community
  • 285 questions tagged on Stack Overflow
  • A bit persnickety about whitespace and alignment if you ask me
  • Lists (especially nested lists) and paragraphs always seem to get in fights
  • Readable by non-programmers
  • Only format which can build a table of contents (via an extension in the Python reference implementation)
  • Directly converts to other formats like PDF and XML
  • Ideal for large documents with lots of prose (e.g. an alternative to docbook for a user manual)
  • Syntax reference
旧情勿念 2024-07-21 20:08:50

您还可以考虑 asciidoc

  • 各种文档元素(例如,参考书目、
    脚注,. 。 .)
  • 有些人可能认为它在语法方面相对“挑剔”(相对于灵活)

asciidoctor 支持输出到:

  • DocBook
  • HTML
  • 手册页
  • PDF
  • EPUB

很棒的 AsciiDoc 页面提供了一个很好的相关资源列表。

You might also consider asciidoc:

  • relatively readable markup
  • support for a wide variety of document elements (e.g., bibliography,
    footnotes, . . .)
  • some might perceive it as relatively 'picky' (vs. flexible) with respect to syntax

asciidoctor supports output to:

  • DocBook
  • HTML
  • man pages
  • PDF
  • EPUB

The Awesome AsciiDoc page provides a nice list of associated resources.

墨洒年华 2024-07-21 20:08:50

关于轻量级标记语言的维基百科页面对各种选项进行了很好的比较,并显示了语法用于常见用途(标题、粗体、斜体等)

The Wikipedia page on lightweight markup languages has a good comparison between the various options, as well as showing syntax for common uses (headings, bold, italics, etc.)

森末i 2024-07-21 20:08:50

我试图在这里涵盖所有各种轻量级标记语言:

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

如您所见,它以“如何制作一个安全的博客”开始 - 即生成静态 HTML 的博客,我发现自己陷入了标记语言、模板系统等的陷阱

更新

我只重新关注带有Python实现的LWML,它们在这里:

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

到目前为止,我已经尝试过 markdown 和 ReST,我更喜欢后者,但除了
嵌入其他页面的 HTML 片段。 表格、交叉引用、间接链接等...

I am attempting to cover all the various lightweight markup languages here:

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

As you can see, it started with "how can I make a secure blog" - i.e. one that generates static HTML, and I found myself ensnared in markup languages, templating systems, etc.

Update

I refocused only on LWMLs with python implementations, and theyre here:

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

So far I've tried markdown and ReST, and I like the latter better for anything but
HTML snippets embedded in other pages. Tables, cross refs, indirect links, etc...

尾戒 2024-07-21 20:08:50

用于文档?
doxygen 怎么样?

我已经将它用于一些我需要记录的 c/c++ 项目。
即使您可以“滥用”它,就像 doxygen 作者用于 doxygen 文档一样

for documentation?
how about doxygen?

I've use it for some of c/c++ project that I need to documentize.
Even you can 'abuse' it just like doxygen author uses for doxygen documentation

~没有更多了~
我们使用 Cookies 和其他技术来定制您的体验包括您的登录状态等。通过阅读我们的 隐私政策 了解更多相关信息。 单击 接受 或继续使用网站,即表示您同意使用 Cookies 和您的相关数据。
原文