Skip to content

The "Reading Progress Bar" plugin for Publii enhances user engagement by visually displaying their reading progress on a post.

License

Notifications You must be signed in to change notification settings

htejera/publii-reading-progress-bar

Repository files navigation

Reading Progress Bar Plugin for Publii

Reading Progress Bar Plugin for Publii

This Publii plugin adds a dynamic reading progress bar to your site, visually indicating to users how far they've scrolled through an article. The progress bar is a thin, subtle line that appears at the top of the page and fills in as the user scrolls down.

Example

Open demo

Features

  • Simple Integration: Easily integrates with your Publii site with minimal setup.
  • Customizable: Style the progress bar with custom CSS to match your site's design.
  • Lightweight: Adds minimal overhead to your site's loading times.

Installation

  1. Download the plugin from the Release page.
  2. In Publii, go to "Plugins" > "Add new" and select the downloaded ZIP file
  3. Go to the "Plugins" section in the Publii app and enable the "Reading Time" plugin.
  4. Once installed, the plugin will automatically start calculating and displaying the reading time for your posts.

Configuration

The plugin offers the following configuration options:

  • Bar Color: Set the color of the progress bar. Default: black.
  • Bar Height: Set the height of the progress bar in pixels. Default: 4.

Configuration

Customization

To further customize the display of the reading time, users can override the CSS used by the plugin: #progress

License

This plugin is licensed under the MIT License.

Feel free to contribute to the development or suggest improvements by submitting a pull request or opening an issue on GitHub.

About

The "Reading Progress Bar" plugin for Publii enhances user engagement by visually displaying their reading progress on a post.

Topics

Resources

License

Stars

Watchers

Forks