atmosphereJS没有获取readme.md文件

Question

我创建了一个包并将其托管在gitlab上。我已经在pakage.js上设置了README.md（我使用的是默认的，我只是替换了README.md中的文本），但README.md中的文本似乎没有反映出包的概述。请告诉我出了什么问题。

这是我的package.js 的内容

    Package.describe({
      name: 'myname:mypackage',
      version: '0.0.2',
      summary: 'mypackage',
      git: 'https://gitlab.com/zeitgeist/mypackage.git',
      // By default, Meteor will default to using README.md for documentation.
      // To avoid submitting documentation, set this field to null.
      documentation: 'README.md'
    });

Answer 1

默认情况下，就像你在注释上一样，如果你在项目的根上有README.md，它会接受它并使用GitHub风格的Markdown。

但是由于您使用的是documentation:'README.md'字段。

你应该把readme的路径放在下面的语法上。

documentation: 'path/to/my/readme.md',

查看更多大气DOCS

因此，如果您在项目的根目录上有README.md，只需将此字段设置为null或将其删除即可。

Package.describe({
      name: 'myname:mypackage',
      version: '0.0.2',
      summary: 'mypackage',
      git: 'https://gitlab.com/zeitgeist/mypackage.git',
      // By default, Meteor will default to using README.md for documentation.
      // To avoid submitting documentation, set this field to null.
      documentation: null //or delete it
    });