Атмосфера JS не подхватывает файл readme.md?

Question

Я создал пакет и разместил его на gitlab. Я установил README.md для pakage.js (я использую файл по умолчанию, я просто заменил текст внутри 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' поле.

Вы должны указать путь к 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
    });