mdformat-sentencebreak
An mdformat plugin that adds line wrapping based on sentence completion marks.
Behavior
This input ....
> Long sentences are broken at punctuation marks,
> unless the generated sentence would be extremely small
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna.
> And it will not break sentences if
> they are inside something else ... emphasis for example
**Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna.**
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna.
**Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna.**
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna.
> Sentences are kept separate if they end in punctuation
Some.
Very.
Small.
Series.
of.
Sentences.
> Sentences are combined if they do not end in punctuation.
a
very
sloppy
sentence
Will get this ....
Lorem ipsum dolor sit amet,
consectetur adipiscing elit,
sed do eiusmod tempor incididunt ut labore et dolore magna.
**Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna.**
Lorem ipsum dolor sit amet,
consectetur adipiscing elit,
sed do eiusmod tempor incididunt ut labore et dolore magna.
**Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna.**
Lorem ipsum dolor sit amet,
consectetur adipiscing elit,
sed do eiusmod tempor incididunt ut labore et dolore magna.
Some.
Very.
Small.
Series.
of.
Sentences.
a very sloppy sentence
Installation
pip install mdformat-sentencebreak
Or using pipx
pipx install mdformat
pipx inject mdformat mdformat-sentencebreak
Usage
After installing mdformat and mdformat-sentencebreak, you can format a markdown file by calling:
mdformat {NAME_OF_YOUR_MARKRDOWN_FILE.md}
TODO:
- Support for ellipsis in a long line
- (...) gets broken into . ..
1 maintainer
Metadata
1 maintainer
Release files for mdformat-sentencebreak 0.4.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| mdformat-sentencebreak-0.4.0.tar.gz | 4.9 kB | Without provenance | Details for mdformat-sentencebreak-0.4.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| mdformat_sentencebreak-0.4.0-py3-none-any.whl | Python 3 | none | any | Details for mdformat_sentencebreak-0.4.0-py3-none-any.whl |
Total release size: 10.1 kB
Release files / mdformat-sentencebreak-0.4.0.tar.gz
| Download URL | mdformat-sentencebreak-0.4.0.tar.gz |
|---|---|
| Size | 4.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
a3bf5c28957d9f6c7aa74c663291024131f416d5d2e23339af6fcf408fa6ad31
|
|
BLAKE2b-256 checksum How to use checksums |
7f3b26be2c08a1c210e65218e36980bfb6fe724ea7f1675031749a388864ffbb
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.2.0 CPython/3.10.6 Linux/5.15.0-1019-azure
|
Release files / mdformat_sentencebreak-0.4.0-py3-none-any.whl
| Download URL | mdformat_sentencebreak-0.4.0-py3-none-any.whl |
|---|---|
| Size | 5.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
699e876c4e8cf2b0078a9345b3d30b437a74409287457dbafd6da70655fef64d
|
|
BLAKE2b-256 checksum How to use checksums |
926e4b873a30e00fd6f8fd01162523a0927ef62720d27a6e38cc54ee55eb4dcf
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.2.0 CPython/3.10.6 Linux/5.15.0-1019-azure
|
Security for mdformat-sentencebreak 0.4.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
