Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@suin/mdast-character-count

suin15MIT1.0.0TypeScript support: included

A utility to count characters in Markdown

unist, mdast, mdast-util, markdown, character-count, character-counter

readme

@suin/mdast-character-count

[mdast] utility to count characters.

Installation

yarn add @suin/mdast-character-count
# or
npm install @suin/mdast-character-count

Usage

import { countCharacter } from "@suin/mdast-character-count";

const text = markdown`
# 12345

1234567890

- 12345
- 12345

~~~
12345
~~~
`;
const tree = mdastUtilFromMarkdown(text);
const { textCharacters, codeCharacters } = countCharacter(tree);

console.log(textCharacters); //=> 25
console.log(codeCharacters); //=> 5

More examples, see example.test.ts.

API Reference

https://suin.github.io/mdast-character-count/

changelog

1.0.0 (2021-11-08)

Features

  • 🎸 add countCharacter function (d01ccb1)