Skip to content

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

License

Notifications You must be signed in to change notification settings

gandreadis/markdown-word-count

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

46 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

⬇ Markdown Word Count

Python package

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 its name (relative path) to the mwc script:

mwc yourfile.md

You can also pass in multiple files or a blob if your shell supports it. This allows for checking all files in a folder, for example.

mwc text1.md text2.md
mwc test/*.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

About

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

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •  

Languages