<commit_before># mdast-contributors

![](http://img.shields.io/badge/stability-stable-orange.svg?style=flat)
![](http://img.shields.io/npm/v/mdast-contributors.svg?style=flat)
![](http://img.shields.io/npm/dm/mdast-contributors.svg?style=flat)
![](http://img.shields.io/npm/l/mdast-contributors.svg?style=flat)

[mdast](https://github.com/wooorm/mdast) plugin to inject a given list of contributors
into a table in a markdown file.

## Usage

[![NPM](https://nodei.co/npm/mdast-contributors.png)](https://nodei.co/npm/mdast-contributors/)

## License

MIT. See [LICENSE.md](http://github.com/hughsk/mdast-contributors/blob/master/LICENSE.md) for details.

## Contributors

| Name             | GitHub                              | Twitter                                           |
| ---------------- | ----------------------------------- | ------------------------------------------------- |
| **<NAME>** | [hughsk](https://github.com/hughsk) | [@hughskennedy](https://twitter.com/hughskennedy) |<commit_msg>documentation<commit_after># mdast-contributors

![](http://img.shields.io/badge/stability-stable-orange.svg?style=flat)
![](http://img.shields.io/npm/v/mdast-contributors.svg?style=flat)
![](http://img.shields.io/npm/dm/mdast-contributors.svg?style=flat)
![](http://img.shields.io/npm/l/mdast-contributors.svg?style=flat)

[mdast](https://github.com/wooorm/mdast) plugin to inject a given list of contributors
into a table in a markdown file.

Safe to be run on your `README.md` file before each commit
without creating unnecessary noise!

## Usage

[![NPM](https://nodei.co/npm/mdast-contributors.png)](https://nodei.co/npm/mdast-contributors/)

Used as a plugin for mdast like so:

```javascript
const plugin = require('mdast-contributors')
const mdast  = require('mdast')

readme = mdast.use(plugin, {
  contributors: [
    {
      name: '<NAME>',
      twitter: 'hughskennedy',
      github: 'hughsk'
    }
  ]
}).process(readme)
```

This will add a "Contributors" section to your document if
one is not already present. If one is present, a list of
contributors will be added to that section.

For example, the following input markdown:

```markdown
# My Readme

Hello World!
```

Would yield:

```markdown
# My Readme

Hello World!

## Contributors

| Name             | GitHub                              | Twitter                                           |
| ---------------- | ----------------------------------- | ------------------------------------------------- |
| **<NAME>** | [hughsk](https://github.com/hughsk) | [@hughskennedy](https://twitter.com/hughskennedy) |
```

Any other text in the contributors section will still be
preserved, so you can still include appreciative personal
gratitude of your choosing.

### `options.contributors`

Required. An array of contributors, each with the following
properties:

-   `name`: the preferred name of the contributor.
-   `github`: the GitHub account of the contributor.
-   `twitter`: the Twitter account of the contributor, with or without an `@`.

## License

MIT. See [LICENSE.md](http://github.com/hughsk/mdast-contributors/blob/master/LICENSE.md) for details.

## Contributors

| Name             | GitHub                              | Twitter                                           |
| ---------------- | ----------------------------------- | ------------------------------------------------- |
| **<NAME>** | [hughsk](https://github.com/hughsk) | [@hughskennedy](https://twitter.com/hughskennedy) |
{'fraction_non_alphanumeric': 0.2244196044711952, 'fraction_numerical': 0.0, 'mean_word_length': 2.193046660567246, 'pattern_counts': {'":': 0, '<': 7, '<?xml version=': 0, '>': 7, 'https://': 12, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 4, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '2291458', 'n_tokens_mistral': 1093, 'n_tokens_neox': 1014, 'n_words': 226}