package
Put your contributors faces in your readme.
npm install contributor-facesGitHub-flavored package documentation.
Across all versions, last 30 days.
2,199 in 30 days
Runtime metadata.
Tagged topics.
Put your contributors faces in your readme.
contributor-faces lets you display a list of your contributors in your readme. It also
allows you to list contributors by contributions in javascript or html.
npm install --save contributor-facesimport contributors from 'contributor-faces'
// get an array of contributors
contributors().then(...)
// get contributors list as html
contributors.render().then(...)
// update contributors list in readme
contributors.update().then(...)
// exclude some contributors
contributors('.', { exclude: '*-bot' }).then(...)contributor-faces [<directory>]To keep your contributor list up-to-date, your have to specify a placeholder for
contributor-faces:
[//]: contributor-facesThen whenever you update your readme, the placeholder will get updated like this:
[//]: contributor-faces
<a href="https://github.com/ngryman"><img src="https://avatars.githubusercontent.com/u/892048?v=3" title="ngryman" width="80" height="80"></a>
[//]: contributor-faces[//]: contributor-faces?markdown does not officially support non visible text or comments. A known workaround is to use a
link label to do so. contributor-faces uses a specific link label to process your readme:
// is only decorative and means it's a commentcontributor-faces serves as the placeholder identifier.MIT © Nicolas Gryman
Estimated unpacked size across 32 packages.
5.9 MB
Includes dependencies.
5 direct · 4 outdated
^3.7.0
14.1.0
^9.0.0
12.0.0
^2.3.11
4.0.8
^1.0.0
1.0.0
^2.0.1
9.0.0