Как мне обрабатывать readme моего пакета на npmjs.com?

Question

У меня очень ограниченный опыт работы с фактическим выпуском пакетов npm, так что это, скорее всего, довольно любительский вопрос. Первоначально у меня создалось впечатление, что readme, представленный на странице npmjs.com пакета, был заполнен указанием поляи/или "readmeFilename" в моем пакете. Json. I recently learned, что это, по сути, совершенно неверно, и я не должен касаться ни одного из этих полей.

Имея это в виду, как мне контролировать, что отображается на моей странице пакета? Он автоматически извлекается из файла README.md? Если да, будет ли он автоматически обновляться, если я изменил readme и снова запустил npm publish? Какой парсер разметки использует сайт npm?

Answer 1

Если ваш проект находится на github, вы можете изменить свой readme.me в github. Затем вы должны вытащить репозиторий в локальный репозиторий. Затем, когда вы запустите npm publish для последней версии, он получит последний файл readme.md. По какой-либо причине, если обновленного файла нет, вы должны пометить свой пакет тегом latest с номером npm.

Надеюсь, это вам поможет.

Благодаря