atmosphereJS 没有获取 readme.md 文件?
atmosphereJS is not picking up readme.md file?
我创建了一个包并将其托管在 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'
});
默认情况下,就像您在评论中所做的那样,如果您在项目的根目录中有 README.md
,它将使用它并使用 GitHub Flavored Markdown。
但由于您使用的是 documentation:'README.md'
字段。
您应该将自述文件的路径放在以下语法中。
documentation: 'path/to/my/readme.md',
查看更多 Atmosphere DOCS
因此,如果您在项目的根目录中有 README.md,只需将此字段设置为空或将其删除即可。
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
});
我创建了一个包并将其托管在 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'
});
默认情况下,就像您在评论中所做的那样,如果您在项目的根目录中有 README.md
,它将使用它并使用 GitHub Flavored Markdown。
但由于您使用的是 documentation:'README.md'
字段。
您应该将自述文件的路径放在以下语法中。
documentation: 'path/to/my/readme.md',
查看更多 Atmosphere DOCS
因此,如果您在项目的根目录中有 README.md,只需将此字段设置为空或将其删除即可。
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
});