README

<!--header--> <table> <tr><td colspan="2"><a href="/README.md#-plugins">← Back to plugins index</a></td></tr> <tr><th colspan="2"><h3>🧑‍🤝‍🧑 People</h3></th></tr> <tr><td colspan="2" align="center"><p>This plugin can display relationships with users, such as followers, sponsors, contributors, stargazers, watchers, members, etc.</p> </td></tr> <tr><th>⚠️ Disclaimer</th><td><p>This plugin is not affiliated, associated, authorized, endorsed by, or in any way officially connected with <a href="https://github.com">GitHub</a>. All product and company names are trademarks™ or registered® trademarks of their respective holders.</p> </td></tr> <tr> <th rowspan="3">Supported features _{<a href="metadata.yml">→ Full specification</a>}</th> <td><a href="/source/templates/classic/README.md"><code>📗 Classic template</code></a> <a href="/source/templates/repository/README.md"><code>📘 Repository template</code></a></td> </tr> <tr> <td><code>👤 Users</code> <code>👥 Organizations</code> <code>📓 Repositories</code></td> </tr> <tr> <td><code>🔑 (scopeless)</code> <code>read:org (optional)</code> <code>read:user (optional)</code> <code>read:packages (optional)</code> <code>repo (optional)</code></td> </tr> <tr> <td colspan="2" align="center"> <details open><summary>Related to a user</summary></img></details> <details><summary>Related to a repository</summary></img></details> </tr> </table> <!--/header-->

➡️ Available options

<!--options--> <table> <tr> <td align="center" nowrap="nowrap">Option</i></td><td align="center" nowrap="nowrap">Description</td> </tr> <tr> <td nowrap="nowrap"><h4><code>plugin_people</code></h4></td> <td rowspan="2"><p>Enable people plugin</p> </td> </tr> <tr> <td nowrap="nowrap"><b>type:</b> <code>boolean</code>

<b>default:</b> no

</td> </tr> <tr> <td nowrap="nowrap"><h4><code>plugin_people_limit</code></h4></td> <td rowspan="2"><p>Display limit</p> </td> </tr> <tr> <td nowrap="nowrap"><b>type:</b> <code>number</code> <i>(0 ≤ 𝑥)</i>

<b>zero behaviour:</b> disable</br> <b>default:</b> 24

</td> </tr> <tr> <td nowrap="nowrap"><h4><code>plugin_people_identicons</code></h4></td> <td rowspan="2"><p>Force identicons pictures</p> <p>Can be used to mask profile pictures for privacy</p> </td> </tr> <tr> <td nowrap="nowrap"><b>type:</b> <code>boolean</code>

<b>default:</b> no

</td> </tr> <tr> <td nowrap="nowrap"><h4><code>plugin_people_identicons_hide</code></h4></td> <td rowspan="2"><p>Hide identicons pictures</p> <p>Can be used to mask users without a personal profile picture.</p> <p>When used with <a href="/source/plugins/people/README.md#plugin_people_identicons"><code>plugin_people_identicons</code></a>, users without a personal profile picture will still be filtered out, but their picture will be replaced by an identicon instead</p> </td> </tr> <tr> <td nowrap="nowrap"><b>type:</b> <code>boolean</code>

<b>default:</b> no

</td> </tr> <tr> <td nowrap="nowrap"><h4><code>plugin_people_size</code></h4></td> <td rowspan="2"><p>Profile picture display size</p> </td> </tr> <tr> <td nowrap="nowrap"><b>type:</b> <code>number</code> <i>(8 ≤ 𝑥 ≤ 64)</i>

<b>default:</b> 28

</td> </tr> <tr> <td nowrap="nowrap"><h4><code>plugin_people_types</code></h4></td> <td rowspan="2"><p>Displayed sections</p> <p>User and organization accounts support the following values:</p> <ul> <li><code>followers</code></li> <li><code>following</code>/<code>followed</code></li> <li><code>sponsoring</code>/<code>sponsored</code></li> <li><code>sponsors</code></li> <li><code>members</code> (organization only)</li> <li><code>thanks</code>(to be configured with <a href="/source/plugins/people/README.md#plugin_people_thanks"><code>plugin_people_thanks</code></a>)</li> </ul> <p>Repositories support the following values:</p> <ul> <li><code>sponsors</code> (same as owner sponsors)</li> <li><code>contributors</code></li> <li><code>stargazers</code></li> <li><code>watchers</code></li> <li><code>thanks</code>(to be configured with <a href="/source/plugins/people/README.md#plugin_people_thanks"><code>plugin_people_thanks</code></a>)</li> </ul> <p>Specified order is honored</p> </td> </tr> <tr> <td nowrap="nowrap"><b>type:</b> <code>array</code> <i>(comma-separated)</i>

<b>default:</b> followers, following

<b>allowed values:</b><ul><li>followers</li><li>following</li><li>followed</li><li>sponsoring</li><li>members</li><li>sponsored</li><li>sponsors</li><li>contributors</li><li>stargazers</li><li>watchers</li><li>thanks</li></ul></td>

</tr> <tr> <td nowrap="nowrap"><h4><code>plugin_people_thanks</code></h4></td> <td rowspan="2"><p>Special thanks</p> <p>Can be used to thank specific users</p> </td> </tr> <tr> <td nowrap="nowrap">⏯️ Cannot be preset

<b>type:</b> <code>array</code> <i>(comma-separated)</i>

</td> </tr> <tr> <td nowrap="nowrap"><h4><code>plugin_people_sponsors_custom</code></h4></td> <td rowspan="2"><p>Custom sponsors</p> <p>This list can be used to add users from unsupported GitHub sponsors sources. The option <a href="/source/plugins/people/README.md#plugin_people_types"><code>plugin_people_types</code></a> must contain the <code>sponsors</code> section in order for this setting to be effective</p> </td> </tr> <tr> <td nowrap="nowrap">⏯️ Cannot be preset

<b>type:</b> <code>array</code> <i>(comma-separated)</i>

</td> </tr> <tr> <td nowrap="nowrap"><h4><code>plugin_people_shuffle</code></h4></td> <td rowspan="2"><p>Shuffle data</p> <p>Can be used to create varied outputs This will fetch additional data (10 times <a href="/source/plugins/people/README.md#plugin_people_limit"><code>plugin_people_limit</code></a>) to ensure output is always different</p> </td> </tr> <tr> <td nowrap="nowrap"><b>type:</b> <code>boolean</code>

<b>default:</b> no

</td> </tr> </table> <!--/options-->

ℹ️ Examples workflows

<!--examples--> <!--/examples-->