Skip to content

Commit

Permalink
Merge pull request #130 from sounisi5011/release-0.3.2
Browse files Browse the repository at this point in the history
Release 0.3.2
  • Loading branch information
sounisi5011 committed Jan 5, 2020
2 parents 5083aa6 + 68a52e3 commit 735473d
Show file tree
Hide file tree
Showing 4 changed files with 17 additions and 13 deletions.
8 changes: 6 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,15 @@

## [Unreleased]

[Unreleased]: https://github.com/sounisi5011/metalsmith-netlify-published-date/compare/v0.3.2...master

## [0.3.2] (2020-01-05 UTC)

### Documentation

* [#129] - Fix README

[Unreleased]: https://github.com/sounisi5011/metalsmith-netlify-published-date/compare/v0.3.1...master
[0.3.2]: https://github.com/sounisi5011/metalsmith-netlify-published-date/compare/v0.3.1...v0.3.2
[#129]: https://github.com/sounisi5011/metalsmith-netlify-published-date/pull/129

## [0.3.1] (2020-01-05 UTC)
Expand All @@ -26,7 +30,7 @@

* [#124] - Increasing test execution interval using external API

[0.3.1]: https://github.com/sounisi5011/metalsmith-netlify-published-date/compare/v0.3.0...master
[0.3.1]: https://github.com/sounisi5011/metalsmith-netlify-published-date/compare/v0.3.0...v0.3.1
[#123]: https://github.com/sounisi5011/metalsmith-netlify-published-date/pull/123
[#124]: https://github.com/sounisi5011/metalsmith-netlify-published-date/pull/124
[#126]: https://github.com/sounisi5011/metalsmith-netlify-published-date/pull/126
Expand Down
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,34 +3,34 @@
[![Go to the latest release page on npm](https://img.shields.io/npm/v/@sounisi5011/metalsmith-netlify-published-date.svg)][npm]
[![License: MIT](https://img.shields.io/static/v1?label=license&message=MIT&color=green)][github-license]
![Supported Node.js version: >=8.3.0](https://img.shields.io/static/v1?label=node&message=%3E%3D8.3.0&color=brightgreen)
[![Install Size Details](https://packagephobia.now.sh/badge?p=@sounisi5011/metalsmith-netlify-published-date@0.3.1)](https://packagephobia.now.sh/result?p=@sounisi5011/metalsmith-netlify-published-date@0.3.1)
[![Install Size Details](https://packagephobia.now.sh/badge?p=@sounisi5011/metalsmith-netlify-published-date@0.3.2)](https://packagephobia.now.sh/result?p=@sounisi5011/metalsmith-netlify-published-date@0.3.2)
[![Dependencies Status](https://david-dm.org/sounisi5011/metalsmith-netlify-published-date/status.svg)](https://david-dm.org/sounisi5011/metalsmith-netlify-published-date)
[![Build Status](https://dev.azure.com/sounisi5011/npm%20projects/_apis/build/status/sounisi5011.metalsmith-netlify-published-date?branchName=master)](https://dev.azure.com/sounisi5011/npm%20projects/_build/latest?definitionId=7&branchName=master)
[![Maintainability Status](https://api.codeclimate.com/v1/badges/913d0fe6324ac84907d6/maintainability)](https://codeclimate.com/github/sounisi5011/metalsmith-netlify-published-date/maintainability)

[npm]: https://www.npmjs.com/package/@sounisi5011/metalsmith-netlify-published-date
[github-license]: https://github.com/sounisi5011/metalsmith-netlify-published-date/blob/v0.3.1/LICENSE
[github-license]: https://github.com/sounisi5011/metalsmith-netlify-published-date/blob/v0.3.2/LICENSE

Get published date and modified date of the each page published by Netlify.

## Install

```sh
npm install @sounisi5011/metalsmith-netlify-published-date@0.3.1
npm install @sounisi5011/metalsmith-netlify-published-date@0.3.2
```

## Usage

There is an example of a working configuration in the `./example/` directory.
Please check: https://github.com/sounisi5011/metalsmith-netlify-published-date/tree/v0.3.1/example
Please check: https://github.com/sounisi5011/metalsmith-netlify-published-date/tree/v0.3.2/example

## Options

**This release is unstable. Some options may be change or remove before version 1.x is released.**

To see a list of the latest commit options, see the type definition in the `./src/plugin.ts` file: https://github.com/sounisi5011/metalsmith-netlify-published-date/blob/v0.3.1/src/plugin.ts#L32-L64
To see a list of the latest commit options, see the type definition in the `./src/plugin.ts` file: https://github.com/sounisi5011/metalsmith-netlify-published-date/blob/v0.3.2/src/plugin.ts#L32-L64

Also check the test code in the `./test/options/` directory for options available in the JSON file: https://github.com/sounisi5011/metalsmith-netlify-published-date/tree/v0.3.1/test/options
Also check the test code in the `./test/options/` directory for options available in the JSON file: https://github.com/sounisi5011/metalsmith-netlify-published-date/tree/v0.3.2/test/options

### `pattern`

Expand Down Expand Up @@ -75,7 +75,7 @@ netlifyPublishedDate({
})
```

Note: The return value of the function is [delimited by the path delimiter and then URL escaped](https://github.com/sounisi5011/metalsmith-netlify-published-date/blob/v0.3.1/src/plugin.ts#L144-L150). That is, the value that this function must return is not a URL, but a file path before it is converted to a URL.
Note: The return value of the function is [delimited by the path delimiter and then URL escaped](https://github.com/sounisi5011/metalsmith-netlify-published-date/blob/v0.3.2/src/plugin.ts#L144-L150). That is, the value that this function must return is not a URL, but a file path before it is converted to a URL.

### `metadataUpdater`

Expand All @@ -84,15 +84,15 @@ Content converted with the function specified in this option is used for content

The page data obtained from the Netlify preview is passed to the first argument. Parse this data and update the Metalsmith metadata passed in the second argument.

See the `set-datetime.js` file in the `./example/` directory for verbose usage: https://github.com/sounisi5011/metalsmith-netlify-published-date/blob/v0.3.1/example/set-datetime.js
See the `set-datetime.js` file in the `./example/` directory for verbose usage: https://github.com/sounisi5011/metalsmith-netlify-published-date/blob/v0.3.2/example/set-datetime.js

### `contentsConverter`

This function converts the content generated by the plugin specified in the `plugins` option and the content of the web page obtained from the Netlify preview.
Content converted with the function specified in this option is used for content comparison.

In other words, this function is used to remove HTML elements that should be excluded in the comparison.
See the `remove-time-elem.js` file in the `./example/` directory for verbose usage: https://github.com/sounisi5011/metalsmith-netlify-published-date/blob/v0.3.1/example/remove-time-elem.js
See the `remove-time-elem.js` file in the `./example/` directory for verbose usage: https://github.com/sounisi5011/metalsmith-netlify-published-date/blob/v0.3.2/example/remove-time-elem.js

### `cacheDir`

Expand Down
2 changes: 1 addition & 1 deletion package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@sounisi5011/metalsmith-netlify-published-date",
"version": "0.3.1",
"version": "0.3.2",
"description": "Get published date and modified date of the each page published by Netlify",
"keywords": [
"date",
Expand Down

0 comments on commit 735473d

Please sign in to comment.