https://github.com/r12f/hexo-post-series

Adding post to a series and display them in your post.
https://github.com/r12f/hexo-post-series

Last synced: 7 days ago
JSON representation

Adding post to a series and display them in your post.

• Host: GitHub
• URL: https://github.com/r12f/hexo-post-series
• Owner: r12f
• License: bsd-3-clause
• Created: 2017-02-19T03:25:06.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2022-08-25T07:21:50.000Z (about 2 years ago)
• Last Synced: 2024-09-15T14:06:13.325Z (about 2 months ago)
• Language: JavaScript
• Size: 10.7 KB
• Stars: 6
• Watchers: 3
• Forks: 4
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

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.

```



    
{post series list title}

    


        
{post title}

    



```


### 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