Skip to content

Kaid00/joplin-note-statistics

Repository files navigation

Joplin Note Statistics

Note Statistics is a plugin to extend the functionalility of Joplin's inbuilt note statictics.

It allows to get statistics on number of words, images, links and more for any selected note, in a extra dialog view, which can be accessed from the toolbar

Table of contents

Features

Statistics such as:

  • Number of:

    • Characters
    • Words
    • Letters
    • Links
    • Images
    • Numbers
    • Lines
    • Code fences
      • Not yet supported right now
  • Note Size

  • Note Read time

Demo

dialog-tool bar

Screenshots

dialog-tool bar

Installation

Automatic (Joplin v1.6.4 and newer)

  • Open Joplin and navigate to Preferences > Plugins
  • Search for Note statistics and press install
  • Restart Joplin to enable the plugin

Manual

  • Download the latest released JPL package (*.jpl) from here
  • Open Joplin and navigate to Tools > Options > Plugins
  • Press Install plugin and select the previously downloaded jpl file
  • Confirm selection
  • Restart Joplin to enable the plugin

Uninstall

  • Open Joplin and navigate to Tools > Options > Plugins
  • Search for the Note Statistics plugin
  • Press Delete to remove the plugin completely
    • Alternatively you can also disable the plugin by clicking on the toggle button
  • Restart Joplin

Usage

From the tool bar

Click on the ℹ️ icon to view the note statistics

Development

The npm package of the plugin can be found here.

Building the plugin

If you want to build the plugin by your own simply run npm run dist.

Install Built plugin

  • Open Joplin Configuration > Plugins section
  • Under Advanced Settings, add the plugin path in the Development plugins text field.
  • This should be the path to your main plugin directory, i.e. path/to/your/root/plugin/directory.

Updating the plugin framework

To update the plugin framework, run npm run update.

License

Copyright (c) 2021 Azamah Junior

MIT License. See LICENSE for more information.