Skip to content

Latest commit

 

History

History
64 lines (41 loc) · 2.08 KB

File metadata and controls

64 lines (41 loc) · 2.08 KB

Series Navigator

Icon

Description

Series Navigator is a Publii plugin that groups posts into ordered series and auto-injects a table of contents at the top and a "next" link at the bottom of every post in the series.

Series are defined in a builder in the plugin settings, no manual JSON editing. Works for any sequential, multi-part content.

Features

  • Group posts into ordered series with a drag-and-drop builder
  • Auto-injected series table of contents at the top of each post
  • Auto-injected "next" link at the bottom of each post
  • Optional numbers in the TOC (e.g. "Part 1:", "Part 2:", …)
  • Customizable "next" link prefix text (e.g. "Next:", "Up next:")
  • Customizable series heading text (e.g. "In this series")
  • Works in both Publii preview and deployed output

Requirements

  • Publii 0.46.0 or newer
  • A theme that exposes a standard post content wrapper. The Simple and Massively themes are tested so far.

Installation

  1. Download the release ZIP.
  2. Publii -> Tools -> Plugins -> Install plugin -> pick the ZIP.
  3. Enable the plugin for the site.

Usage

Open Plugins -> Series Navigator -> settings icon to open the series builder. Create a series, drag your published posts into it, and order them.

Use the Display options to toggle part numbers and to set the heading and "next" link text. Save, then render the site, each post in a series gets its TOC and "next" link automatically.

screenshot

Contributing

Feel free to fork this project or contribute a PR. Build instructions can be found in the developer readme DEV.md.

Licenses

Main code

This project is licensed under the GPLv3+. See LICENSE file for details.

Credits

This project was developed by InPoint Automation Sp. z o.o. https://inpointautomation.com/

Thanks to the Publii project for the CMS and plugin API.

Changelog

See CHANGELOG.md for the full version history.