使用哪种Wiki文本语法或Markdown?

时间:2011-01-11 09:53:24

标签: syntax wiki markdown knowledge-management

处理我的个人知识库...我想格式化我的文档,甚至在wiki语法的本地硬盘上。有时我会将它们上传到(公司)维基,有时我会从那里下载它们。计划中有一些工具可以支持此流程并搜索我的知识库(文档)以供日后使用。显然,我希望降价与大多数兼容,最大限度地减少转换工作。

所以我的问题类似于this related question,但是

  • 当我开始新的东西时,我应该使用什么wiki文本版本或Markdown(方言)? (即文档项目和维基类型)。
  • 最常用的/认可的是什么?
  • 工具支持(编辑和/或库)在哪里最好?有关的前卫。语言是Java,Ruby,Scala。

3 个答案:

答案 0 :(得分:13)

Wikipedia says没有普遍接受的标准wikitext语言。

Creole是“在不同的Wiki上使用通用wiki标记语言”的一种努力。规范的版本1.0和几个wikis and wiki engines实现它。 MediaWiki没有实现它。

Markdown有大量的实现,似乎使用了很多。

由于没有商定的标准,可能会根据features and available implementations选择语言,具体取决于用例。

答案 1 :(得分:2)

(1)虽然有很多维基标记我建议坚持定义明确的标记语言

只有3个纯文本标记,定义明确

  • CommonMark尝试定义强大的语法并标准化常用MarkDown的常用扩展。所有人都喜欢它。非常面向HTML。
  • reStructuredText是标记和完善项目的一致框架(从2001年开始!!)。如果您需要内置于核心规范,内联外部标记,生成HTML / PDF / docbook /等的可扩展性,那么它是您的选择。通过 reStructuredText 记录了几本书和许多软件项目。使用https://readthedocs.org/发布软件检查Sphinx您可以使用离线 JS搜索来构建HTML !!
  • AsciiDoc reStructuredText 竞争,但缺乏内置的可扩展性。它非常面向DocBook。几本书是用 AsciiDoc 编写的。

Textile标记未获得明确定义的规范,并且社区环境较弱。我建议考虑以上3个选项。

(2)你绝对应该坚持使用纯文本文件。

支持所有上述格式的软件,能够为打印和在线发布生成高质量的输出。

我坚持使用RST,因为我需要可扩展性和内联外部标记的能力(使用LaTeX进行数学运算,使用graphviz / dot绘图,使用imagemagic进行绘图等)

我在 Emacs 编辑器内或 bash / grep 内搜索个人提示。出于广告目的,我在线发布我的提示,例如:http://tips.defun.work/

答案 2 :(得分:1)

不幸的是,wiki世界中的格式标准化很少,尽管一些wiki(特别是Atlassian的Confluence,一种商业产品)正朝着XHTML发展。

最广泛使用的Wiki软件是MediaWiki(维基百科成名)。 Mediawiki的标记很难解析,但它已经被广泛使用,并且有很多existing tools用于转换MediaWiki格式和从MediaWiki格式转换,以及编辑具有许多不同在线和离线编辑器的内容。

MediaWiki还有一个功能齐全的API,其中包含许多各种编程语言的客户端库(参见Client code),包括例如。 Ruby的MediaWiki::Gateway