Skip to content

Commit

Permalink
run format and changelog
Browse files Browse the repository at this point in the history
  • Loading branch information
wernerglinka committed Feb 7, 2022
1 parent e6ad84a commit a761955
Show file tree
Hide file tree
Showing 24 changed files with 231 additions and 281 deletions.
22 changes: 22 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
### Changelog

All notable changes to this project will be documented in this file. Dates are displayed in UTC.

Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).

#### Unreleased

- Nested config files [`#19`](https://github.com/wernerglinka/metalsmith-metadata/pull/19)
- Don't attempt to parse a file if the key already exists in the metadata, even if the file is missing [`#9`](https://github.com/wernerglinka/metalsmith-metadata/pull/9)
- Revert 9e2224d2e0dd99661f2174f788a337f1add9d823 [`#16`](https://github.com/wernerglinka/metalsmith-metadata/pull/16)
- Normalizing path options for Windows compatibility. [`#7`](https://github.com/wernerglinka/metalsmith-metadata/pull/7)
- Update dependencies [`#8`](https://github.com/wernerglinka/metalsmith-metadata/pull/8)
- Allow .yml as file extension for YAML as well [`#12`](https://github.com/wernerglinka/metalsmith-metadata/pull/12)
- added tests [`e6ad84a`](https://github.com/wernerglinka/metalsmith-metadata/commit/e6ad84a533c1658ac749b35887ad73fb9a5f6ac3)
- first commit [`48bcefc`](https://github.com/wernerglinka/metalsmith-metadata/commit/48bcefcb049d896158aedd340149417a600d4c4c)
- don't try and parse if the key already exists in the metadata... [`c3353d8`](https://github.com/wernerglinka/metalsmith-metadata/commit/c3353d83f8eed5645e9178e5556c6dabf9d23e4e)
- Add tests for nested and deep-nested path [`e525a11`](https://github.com/wernerglinka/metalsmith-metadata/commit/e525a11bce359214afab15d3fa5ddedea88eadcb)
- more tests [`6b0cf69`](https://github.com/wernerglinka/metalsmith-metadata/commit/6b0cf696cea1321348fe5dd3d9c0b5f9f5043762)
- Add regex for normalizing path [`c9cf34a`](https://github.com/wernerglinka/metalsmith-metadata/commit/c9cf34a199a42f0449647729bb7f4010c2c2470f)
- bump version number [`cc8b115`](https://github.com/wernerglinka/metalsmith-metadata/commit/cc8b11597719811f8fd7043d75d549e6903d6eb1)
- fix test name [`965a9b5`](https://github.com/wernerglinka/metalsmith-metadata/commit/965a9b5d6d5d1f0b7a54381c0719c0a404b2f3dc)
25 changes: 13 additions & 12 deletions Readme.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,16 @@

# metalsmith-metadata

A metalsmith plugin to load global metadata from files.
A metalsmith plugin to load global metadata from files.

Supports `.json` and `.yaml` data.
Supports `.json` and `.yaml` data.

## Installation

$ npm install metalsmith-metadata

## CLI Usage

Install via npm and then add the `metalsmith-metadata` key to your `metalsmith.json` plugins. Each key in the dictionary of options will be the key mixed into the global metadata, like so:
Install via npm and then add the `metalsmith-metadata` key to your `metalsmith.json` plugins. Each key in the dictionary of options will be the key mixed into the global metadata, like so:

```json
{
Expand All @@ -26,17 +25,19 @@

## Javascript Usage

Pass the options to `Metalsmith#use`:
Pass the options to `Metalsmith#use`:

```js
var metadata = require('metalsmith-metadata');

metalsmith.use(metadata({
authors: './path/to/authors.json',
categories: './path/to/categories.yaml'
}));
var metadata = require("metalsmith-metadata");

metalsmith.use(
metadata({
authors: "./path/to/authors.json",
categories: "./path/to/categories.yaml",
})
);
```

## License

MIT
MIT
Loading

0 comments on commit a761955

Please sign in to comment.