Wo finde ich Dokumentation für npm-Pakete?

Question

Wo finde ich Dokumentation für NPM-Pakete?

Ich versuche, die Dokumentation des Npm-Pakets textract zu finden. Ich kann die README file sehen, aber ich kann keine andere Dokumentation finden, analog zu dem, was in RDoc für Ruby-Bibliotheken geschrieben wird. Insbesondere habe ich gesucht, wie Zeilenumbrüche auf "wahr" gesetzt werden, wenn sie innerhalb eines Programms ausgeführt werden, im Gegensatz zur Befehlszeile. Am Ende musste ich mir ansehen, wie cli.js das gemacht hat.

Ich versuchte, npm docs textract zu laufen, aber das schickte mich nur zum GitHub Repo.

rubygems.org hat einen Link zu der Dokumentation für ein bestimmtes Juwel, aber ich konnte das Äquivalent auf der npmjs.com Seite nicht finden.

(Hinweis für jedermann googeln: this page ist über die Python-Bibliothek mit dem gleichen Namen)

Answer 1

Ich kann keine andere Dokumentation, analog finden, was in RDoc für Ruby-Bibliotheken geschrieben.

Die Readme-Datei ist die Dokumentation, analog zu dem, was in RDoc für Ruby-Bibliotheken geschrieben.

Ich habe versucht, npm docs texttract laufen, aber das schickte mich nur zum GitHub Repo.

So schickte es Sie wie erwartet in die Dokumentation.

rubygems.org hat einen Link zu der Dokumentation für ein bestimmtes Juwel, aber ich konnte das Äquivalent auf der npmjs.com Seite für texttract nicht finden.

Und npm hat einen Link zur Dokumentation für ein bestimmtes Modul.

Die Dokumentation für Textract ist hier - es gibt 12 Bildschirme von docs sind:

• https://www.npmjs.com/package/textract

Unabhängig davon, ob Sie mit dem Inhalt der Dokumentation erfüllt sind, ist eine andere Sache. Wenn Sie nicht sind, sollten Sie eine Pull-Anforderung mit einer besseren Dokumentation veröffentlichen.