最好的wiki语法文件在红宝石的代码和项目README文件

Question

是否有任何wiki语法rdoc，降价,...建议在红宝石的世界？我写信有时候，开放源代码并且没有胶其法，我应该用代码文件和README文件。什么有助于我和你为什么使用它。

Answer 1

RDoc是默认文件的工具。该RDoc法是默认的一个内允许红宝石文件和图书馆。

你可能会发现TextTile或降价之外使用红宝石的类文本的文件，如自述或录文件。但这不是标准sintax所以你会需要的方式来告诉析其法写入文件，通常这种方式是文件的扩展。

但，例如，遵循的正是这convenction.除非一个.纺织品。降价的扩展是指定的，该文件分析为RDoc.

• http://github.com/weppos/whois (.rdoc==Rdoc)
• http://github.com/rails/rails/tree/master/railties/ (不扩==Rdoc，但不适用于审查)
• http://github.com/technoweenie/restful-authentication/blob/master/README.textile (.纺织品==纺织品)

请记住：据我所知，在线文件始终是分析为RDoc.

Answer 2

在Github上，人们大多使用RDOC或纺织作为其自述，文件格式。 RDOC也是API文档化你的代码是非常有用的，因为语法集成了非常好的成代码，并愉快的阅读。