Log-Stats 📊

Analyse your Graph for peace of mind (and quiet bragging rights)
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
2. Installation
3. Using the plugin
4. Configuration
5. Issues
6. Contributing
7. License
8. Contact
9. Acknowledgments

About The Project

Get a quick overview of all that's in your graph:

• Number of pages
• Number of queries
• Closed number of tasks
• etc

(back to top)

Installation

Preparation

• Click the 3 dots in the righthand corner and go to Settings.
• Go to Advanced and enable Plug-in system.
• Restart the application.
• Click 3 dots and go to Plugins (or Esc t p).

Install plugin from the Marketplace (recommended)

• Click the Marketplace button and then click Plugins.
• Find the plugin and click Install.

Install plugin manually

• Download a released version assets from Github.
• Unzip it.
• Click Load unpacked plugin, and select destination directory to the unzipped folder.

(back to top)

Using the plugin

The plugin is activated with the slash-command /logstats: Insert Graph Statistics, which will insert the following placeholder:

{{renderer :logstats}}

Just using it will give an overview of the data in your graph.

For debugging purposes you can add something after logstats, like this:

{{renderer :logstats, anything}}

This will give the same information, just without any styling, which makes it easier to copy/paste.

(back to top)

Configuration

• Click the 3 dots in the righthand corner and go to Settings.
• Go to Plugin Settings.
• Select correct plugin.

(back to top)

Issues

The number of pages is off by 14? You are correct, Logseq comes with fourteen built-in pages. They do get counted in the queries. Just accept them as a free bonus.

I type in <something not latin>, and my words don't get counted? You are correct. I do not know how to count non-latin words. Help appreciated.

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Alex Qwxlea - @QwxleaA

Project Link: https://github.com/QWxleA/log-stats/

(back to top)