https://github.com/workeffortwaste/eleventy-plugin-recent-changes

An Eleventy (11ty) plugin that creates a collection containing your recent commit history.
https://github.com/workeffortwaste/eleventy-plugin-recent-changes

11ty 11ty-plugin eleventy eleventy-plugin

Last synced: 4 months ago
JSON representation

An Eleventy (11ty) plugin that creates a collection containing your recent commit history.

• Host: GitHub
• URL: https://github.com/workeffortwaste/eleventy-plugin-recent-changes
• Owner: workeffortwaste
• Created: 2020-10-30T10:41:29.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2022-03-28T13:38:56.000Z (almost 3 years ago)
• Last Synced: 2024-09-14T01:35:47.218Z (5 months ago)
• Topics: 11ty, 11ty-plugin, eleventy, eleventy-plugin
• Language: JavaScript
• Homepage:
• Size: 6.84 KB
• Stars: 8
• Watchers: 2
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

        
# eleventy-plugin-recent-changes

An [Eleventy (11ty)](https://www.11ty.dev/) plugin that creates a collection containing your recent commit history. 

*Automatically create a viewable changelog for your project.*

**Like this project? Help support my projects and buy me a coffee via [ko-fi](https://ko-fi.com/defaced)**.

---

## Getting started

### Install the plugin

In your project directory run:

```sh

# Using npm

npm install eleventy-plugin-recent-changes --save

```

Then update your project's `.eleventy.js` to include the plugin:

```js

const recentChanges = require('eleventy-plugin-recent-changes');

module.exports = function (eleventyConfig) {

  eleventyConfig.addPlugin(recentChanges);

};

```

### Configure the plugin (optional)

You can pass an object with configuration options as the second

parameter:

```js

eleventyConfig.addPlugin(recentChanges, {

  commits: 20, // The maxmium number of commits to add to the collection, before filtering.

  filter: 'news', // Filter only commits that include a specific string.

});

```

## Using the plugin

The plugin will create a collection `recentChanges` containing your recent commit history.

### Layout example

Nunjucks:

```



  {%- for commit in collections.recentChanges %}

        


{{ commit.authorDate }} {{ commit.subject }}

  {%- endfor %}



```


### Collection values

| Value | Description  |

|---|---|

| authorDate | The date of the commit. |

| authorName | The name of the author. |

| subject | The commit message. |

| hash | The full hash of the commit. |

| abbrevHash | The abbreviated hash of the commit. |

## Author

Chris Johnson - [defaced.dev](https://defaced.dev) - [@defaced](http://twitter.co.uk/defaced/)