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 Flavored Markdown。

但是因为您使用的是documentation:'README.md'字段。

您应该在以下语法中添加path-to-readme。

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

详情请见Atmosphere 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
    });

atmosphereJS没有拿起readme.md文件？

1 个答案: