2015-04-04 35 views
1

我創建了一個包並將其託管在gitlab上。我已經在pakage.js上設置了README.md(我使用默認的,我剛剛替換了README.md中的文本),但是README.md中的文本似乎沒有反映包概述。請告訴我什麼是錯的。atmosphereJS沒有讀取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' 
    }); 
+0

嘿謝謝。有趣的是,readme.md剛剛被反映出來。上次我推動的是4月5日。奇怪。我認爲這件事會立即反映出來。 :) – kse3fggfksjpqoow 2015-04-20 03:51:10

回答

1

內容默認情況下,像你這樣的意見,如果你對項目的根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 
    });