/markdown-word-count

⬇ Count the number of words in a Markdown file excluding special elements

Primary LanguagePythonMIT LicenseMIT

⬇ Markdown Word Count

CircleCI status

A word counter for raw Markdown files, excluding punctuation, footnotes, and special Markdown or HTML tag syntax.

💻 Installation

You will need...

  • 🐍 Python 3
  • 🐑 PIP3 or a clone of this repo.

▶ Usage

Through PIP

The easiest way is to run:

pip install markdown-word-count

Then, you'll be able to analyze any file by passing it's name (relative path) to the mwc script:

mwc yourfile.md

Manually

If you want to clone the repo and run the Python script manually, run:

python mwc/cli.py myfile.md

If this doesn't work, try python3 instead of python.

⛏ Development

Run this to execute all tests:

python -m unittest discover

💬 Ports to Other Programming Languages