joplin-note-statistics

KO | EN

gitlite — search

#javascript #python #react #android #rust #macos #java #awesome #cli #kubernetes #vue #awesome-list #ios #open-source

joplin-note-statistics

(★ 14)

Joplin plugin to get note statistics

joplin-note-statistics Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Joplin Note Statistics

Note Statistics is a plugin to extend the functionalility of [Joplin's](https://joplinapp.org/) 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](#features)
  - [Demo](#Demo)
  - [Screenshots](#screenshots)
- [Installation](#installation)
- [Usage](#usage)
- [Development](#usage)
- [Building the plugin](#Building-the-plugin)
- [License](#license)

## 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](https://github.com/Kaid00/joplin-note-statistics/blob/master/assets/demo.gif)

### Screenshots

![dialog-tool bar](https://github.com/Kaid00/joplin-note-statistics/blob/master/assets/note-stats-dialog.png)

## 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](https://github.com/Kaid00/joplin-note-statistics/releases)
- 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](https://www.npmjs.com/package/joplin-plugin-note-stats).

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

MIT License. See [LICENSE](./LICENSE) for more information.

joplin-note-statistics

joplin-note-statistics Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

joplin-note-statistics

joplin-note-statistics Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README