boringmd 1.0.0

Converts Markdown to boring plain text

boringmd

boringmd is a Python package and command line tool for converting Markdown documents to plain text.

boringmd does not render Markdown in any particularly beautiful way. It's a lightweight package for simply extracting plain text content.

Examples

Emphasis

This is *emphasis*, and so is _this_.

This is emphasis, and so is this.

Fenced code

Code sample:

```markdown
# Shopping list

1. Ducks
2. Grapes
3. Basketballs
```

Code sample:

# Shopping list

1. Ducks
2. Grapes
3. Basketballs

Front matter

---
foo: bar
---
I love gummy cakes.

I love gummy cakes.

Headings

# Abraham Lincoln

## Life

### Favourite cakes

Abraham Lincoln might have enjoyed gummy cakes.

Abraham Lincoln

Life

Favourite cakes

Abraham Lincoln might have enjoyed gummy cakes.

HTML

I want a line break<br />here.

I want a line break here.

Indented code

Code sample:

    # Shopping list

    1. Ducks
    2. Grapes
    3. Basketballs

Code sample:

    # Shopping list

    1. Ducks
    2. Grapes
    3. Basketballs

Inline code

Use `git` to clone and `pytest` to test.

Use git to clone and pytest to test.

Strength

This is **strong**.

This is strong.

Usage

Installation

boringmd requires Python 3.8 or later.

pip install boringmd

Command line

On the command line, boringmd prints the conversion to stdout:

boringmd input.md

To write the conversion to a file, redirect it:

boringmd input.md > output.txt

Package

from boringmd import from_string
print(from_string("**foo** and _bar_"))

from pathlib import Path
from boringmd import from_file
print(from_file(Path("input.md")))

Related packages

boringmd uses cariad/lstr to manipulate strings.

Thank you! 🎉

My name is Cariad, and I'm an independent freelance DevOps engineer.

I'd love to spend more time working on projects like this, but--as a freelancer--my income is sporadic and I need to chase gigs that pay the rent.

If this project has value to you, please consider ☕️ sponsoring me. Sponsorships grant me time to work on your wants rather than someone else's.

Thank you! ❤️