Count Md

https://docs.rs/count_md/latest/count_md/
Admin
Count Md is a simple, configurable command-line tool and Rust library for Unicode-aware,...
Tokens:505
Snippets:9
Trust Score:9.1
Update:3 months ago
Show doc for...
Tokens:
Raw
### Install count-md CLI

Source: https://docs.rs/count_md/latest/count_md

Install the command-line tool using cargo with the cli feature enabled.

```bash
cargo install count-md --features="cli"
```

--------------------------------

### Example Markdown content

Source: https://docs.rs/count_md/latest/count_md

A sample Markdown file structure used to demonstrate word counting behavior.

```markdown
# Title

This is some text!

> Here is a quote from someone else.

Here is more text.
```

--------------------------------

### Add count-md dependency

Source: https://docs.rs/count_md/latest/count_md

Add the library to your project using cargo add or by editing Cargo.toml.

```bash
cargo add count-md
```

```toml
[dependencies]
count-md = "0.1"
```

--------------------------------

### Configure counting options

Source: https://docs.rs/count_md/latest/count_md

Modify word counting behavior using bitflags to include or exclude specific Markdown elements.

```rust
let mut options = Options::DEFAULT;
options.insert(Options::IncludeBlockquotes);
options.remove(Options::IncludeHeadings);
```

--------------------------------

### count

Source: https://docs.rs/count_md/latest/count_md

Counts words in a string using the default set of options.

```APIDOC
## count(input: &str) -> usize

### Description
Counts the number of words in the provided Markdown string using the default configuration.

### Parameters
- **input** (&str) - Required - The Markdown content to be counted.
```

--------------------------------

### count_with_options

Source: https://docs.rs/count_md/latest/count_md

Counts words in a string using a custom set of Options.

```APIDOC
## count_with_options(input: &str, options: Options) -> usize

### Description
Counts the number of words in the provided Markdown string using a specific bitmask of options to include or exclude Markdown features.

### Parameters
- **input** (&str) - Required - The Markdown content to be counted.
- **options** (Options) - Required - A bitmask representing the configuration for counting (e.g., Options::DEFAULT | Options::IncludeBlockquotes).
```
Tokens:
Raw