我已经决定将我的一个项目中的README文件转换为markdown，并且一直在使用yard验证呈现出来的文档是否正常。所以我安装了rdiscount，将README更改为README.md并尝试:yarddocREADME.md这给了我警告:[warn]:Syntaxerrorin`readme.md`:(3,18):syntaxerror,unexpectedtinteger,expecting$end所以我尝试了:yarddoc-mmarkdown--README.md同样的问题。运行:yarddoc--backtrace--README.md提供更多信息:[warn]:Synta

.md即markdown文件的基本常用编写语法,是一种快速标记、快速排版语言，现在很多前段项目中的说明文件readme等都是用.md文件编写的，而且很多企业也在在鼓励使用这种编辑方式，特别作为一个前端从业者更要学会使用这种语言。下面就简单和大家分享一些.md基本语法题外话：我一般不安装markdown编辑器，直接用idea就可以编写。一、基本符号：*-+.>基本上所有的markdown标记都是基于这四个符号或组合，需要注意的是，如果以基本符号开头的标记，注意基本符号后有一个用于分割标记符和内容的空格。二、标题1.前面带#号，后面带文字，分别表示h1-h6,只到h6，而且h1下面会有一条横线#一

.md即markdown文件的基本常用编写语法,是一种快速标记、快速排版语言，现在很多前段项目中的说明文件readme等都是用.md文件编写的，而且很多企业也在在鼓励使用这种编辑方式，特别作为一个前端从业者更要学会使用这种语言。下面就简单和大家分享一些.md基本语法题外话：我一般不安装markdown编辑器，直接用idea就可以编写。一、基本符号：*-+.>基本上所有的markdown标记都是基于这四个符号或组合，需要注意的是，如果以基本符号开头的标记，注意基本符号后有一个用于分割标记符和内容的空格。二、标题1.前面带#号，后面带文字，分别表示h1-h6,只到h6，而且h1下面会有一条横线#一

当你想要更好的介绍自己的项目的时候，发现别人的readme都是下面很多花里胡哨的图片介绍，而自己只能写字其实添加图片有两种方式：第一种：在README.MD文件中写入如果这样写的话png就得放在根目录，当然也可以放在文件夹里面，加个路径就好了 绝对的相对的都行![imag

当你想要更好的介绍自己的项目的时候，发现别人的readme都是下面很多花里胡哨的图片介绍，而自己只能写字其实添加图片有两种方式：第一种：在README.MD文件中写入如果这样写的话png就得放在根目录，当然也可以放在文件夹里面，加个路径就好了 绝对的相对的都行![imag

原文链接名词解释RDD：ReadmeDrivenDevelopmentTDD：TestDrivenDevelopmentBDD：Behavior-DrivenDevelopmentXP：ExtremeProgrammingSCRUM:迭代式增量软件开发过程翻译最近我听到很多关于TDD、BDD、XP、SCRUM、站会以及开发更好软件的各种方法和技术的讨论，但这些都是无关紧要的，除非我们所构建的软件能够满足用户的需求。让我换一种说法。有关错误相关的规范的完美实现是毫无价值的。基于同样的原则，一个精心制作的没有文档的库也几乎毫无价值。如果你的软件解决了错误的问题，或者没有人知道如何使用它，那一定是非

原文链接名词解释RDD：ReadmeDrivenDevelopmentTDD：TestDrivenDevelopmentBDD：Behavior-DrivenDevelopmentXP：ExtremeProgrammingSCRUM:迭代式增量软件开发过程翻译最近我听到很多关于TDD、BDD、XP、SCRUM、站会以及开发更好软件的各种方法和技术的讨论，但这些都是无关紧要的，除非我们所构建的软件能够满足用户的需求。让我换一种说法。有关错误相关的规范的完美实现是毫无价值的。基于同样的原则，一个精心制作的没有文档的库也几乎毫无价值。如果你的软件解决了错误的问题，或者没有人知道如何使用它，那一定是非

SmartIDE让你的README变成可执行文档，再也不用编写无用的文档，再也不必操心环境问题。 作为开发者，拿到一个新的代码库的时候一般都会先去看README文件，通过这个文件可以知道这套代码所需要安装的环境，工具和操作方式。这件事情本来应该是一件很愉悦的事情，因为每一套新代码其实都是开发者的新玩具，拿到新玩具的心情那肯定是不错的。但是，当你阅读玩具说明书之后，发现这份说明书完全不配套的时候，那心里一定是一万匹草泥马在奔腾。当然，这也很容易理解，开发者不爱写文档，特别是那些没有用的文档。至少，README对写的人来说其实没啥用，因为写的人都已经清楚了文档中的内容，至于看的人感受如何，那就呵呵

SmartIDE让你的README变成可执行文档，再也不用编写无用的文档，再也不必操心环境问题。 作为开发者，拿到一个新的代码库的时候一般都会先去看README文件，通过这个文件可以知道这套代码所需要安装的环境，工具和操作方式。这件事情本来应该是一件很愉悦的事情，因为每一套新代码其实都是开发者的新玩具，拿到新玩具的心情那肯定是不错的。但是，当你阅读玩具说明书之后，发现这份说明书完全不配套的时候，那心里一定是一万匹草泥马在奔腾。当然，这也很容易理解，开发者不爱写文档，特别是那些没有用的文档。至少，README对写的人来说其实没啥用，因为写的人都已经清楚了文档中的内容，至于看的人感受如何，那就呵呵