# hexo-post-series

> A hexo plugin for creating post series.

Latest version **1.0.10** (published 2022-08-25) · BSD-3-Clause license · 0 weekly downloads

## Install

```sh
npm install hexo-post-series
pnpm add hexo-post-series
yarn add hexo-post-series
bun add hexo-post-series
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.10 |
| Published | 2022-08-25 |
| First published | 2017-02-19 |
| Weekly downloads | 0 |
| License | BSD-3-Clause |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 6.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 6 |
| Author | r12f |
| Maintainers | r12f |
| Keywords | hexo, blog, post, post-series |

## Links

- npm: https://www.npmjs.com/package/hexo-post-series
- Repository: https://github.com/r12f/hexo-post-series
- Homepage: https://github.com/r12f/hexo-post-series#readme
- Issues: https://github.com/r12f/hexo-post-series/issues
- npm.io page: https://npm.io/package/hexo-post-series

## Alternatives

- [postcss-color-hex-alpha](https://npm.io/package/postcss-color-hex-alpha.md) — 6.4M weekly downloads
- [randomcolor](https://npm.io/package/randomcolor.md) — 348.0K weekly downloads
- [bows](https://npm.io/package/bows.md) — 1.3K weekly downloads
- [ep_prefer_color_scheme](https://npm.io/package/ep_prefer_color_scheme.md) — 260 weekly downloads
- [coc-yank](https://npm.io/package/coc-yank.md) — 61 weekly downloads

## Recent versions

- 1.0.10 (latest) — 2022-08-25
- 1.0.8 — 2019-12-31
- 1.0.7 — 2019-12-31
- 1.0.2 — 2017-02-19
- 1.0.1 — 2017-02-19
- 1.0.0 — 2017-02-19

## README

# hexo-post-series

[![npm version](https://badge.fury.io/js/hexo-post-series.svg)](http://badge.fury.io/js/hexo-post-series)

This plugin is made for adding your post to a series and display it anywhere you like in your post.

## Installation

``` bash
$ npm install hexo-post-series --save
```

## Usage

### Add post to a series
Adding post to a series is very easy, just put ```series: series-title-you-like``` to the post info section. For example:
```
---
title: A test post
tags:
  - tag1
  - tag2
series: test-posts
---
```

### Show post series in your post
To show all the posts in the same series as the current post, just add the following tag into your post anywhere you like.
```
{% posts_in_same_series %}
```

### Series list and styles
The post series list is constructed as following. To change its appearance, we can set the css styles in your theme.

```
<div class="post-series">
    <div class="post-series-title">{post series list title}</div>
    <ul class="post-series-list">
        <li class="post-series-list-item"><a href="{post_link}">{post title}</a></li>
    </ul>
</div>
```

### Configurations
The configurations we supported now are quite simple.
* list_title: Specify the title you'd like to show before the list. If list title is empty, we won't generate the post-series-title div.
* open_in_new_tab: If true, a ```target="_blank"``` will be put into the anchor.
* reverse_sort: If true, the most recent created post will be put at first, otherwise, the least recent created post.

Here is a sample:
```
# Post series
post_series:
    list_title: "Same Series:"
    open_in_new_tab: false
    reverse_sort: false
```

## License

BSD v3

---
_Source: https://npm.io/package/hexo-post-series · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._