A simple word count plugin for Grav CMS. This plugin gives you word count statistics for any content.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
assets
docs
twig
CHANGELOG.md
LICENSE.txt
README.md
blueprints.yaml
wordcount.php
wordcount.yaml

README.md

Grav Word Count Plugin

Release Issues Downloads License

This plugin gives you word count statistics for any content.

Table of Contents:

Grav wordcount Plugin

The Grav Word Count Plugin for Grav gives you word count statistics for any content.

Installation and Updates

The Grav Word Count Plugin is easy to install with GPM.

$ bin/gpm install wordcount

Or clone from GitHub and put in the user/plugins/wordcount folder.

For more informations, please check the Installation and update guide.

Usage

Inside content files.

Examples

Get word count from a string

{{ getWordCount('Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nam ut sem tempus, faucibus nulla nec, mattis urna.') }}

Example Output for {{ getWordCount('Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nam ut sem tempus, faucibus nulla nec, mattis urna.') }}

17

Get word count from content

{{ getWordCount(content) }}

Troubleshooting

If you find a bug, please open a new issue

Disclaimer

I've 'written' this plugin for my own use. It comes without any guarantee, so your mileage may vary in using it. If you find bugs or have great additions you'd like to share, use github to fork the project and share your improvements by initiating pull request

Tested on Grav

Latest Stable Version

Contributing

You can contribute at any time! Before opening any issue, please search for existing issues and review the guidelines for contributing.

After that please note:

  • If you find a bug, would like to make a feature request or suggest an improvement, please open a new issue. If you have any interesting ideas for additions to the syntax please do suggest them as well!
  • Feature requests are more likely to get attention if you include a clearly described use case.
  • If you wish to submit a pull request, please make again sure that your request match the guidelines for contributing and that you keep track of adding unit tests for any new or changed functionality.

See also the list of contributors who participated in this project.

Licence

See Licence

Thanks

Sommerregen/grav-plugin-shortcodes

getgrav/grav