s9e/text-formatter
Multi-purpose text formatting and markup library. Plugins offer support for BBCodes, Markdown, emoticons, HTML, embedding third-party media (YouTube, etc...), enhanced typography and more.
Maintainers
Requires
- php: ^8.1
- ext-dom: *
- ext-filter: *
- lib-pcre: >=8.13
- s9e/regexp-builder: ^1.4
- s9e/sweetdom: ^3.4
Requires (Dev)
- code-lts/doctum: *
- friendsofphp/php-cs-fixer: ^3.52
- matthiasmullie/minify: *
- phpunit/phpunit: ^9.5
Suggests
- ext-curl: Improves the performance of the MediaEmbed plugin and some JavaScript minifiers
- ext-intl: Allows international URLs to be accepted by the URL filter
- ext-json: Enables the generation of a JavaScript parser
- ext-mbstring: Improves the performance of the PHP renderer
- ext-tokenizer: Improves the performance of the PHP renderer
- ext-xsl: Enables the XSLT renderer
- ext-zlib: Enables gzip compression when scraping content via the MediaEmbed plugin
Provides
None
Conflicts
None
Replaces
None
This package is auto-updated.
Last update: 2026-05-25 19:56:17 UTC
README
s9e\TextFormatter is a text formatting library that supports BBCode, Markdown, HTML and other markup via plugins. The library is written in PHP, with a JavaScript port also available for client-side preview (see below.)
👁 Packagist Version
👁 Scrutinizer Quality Score
👁 Code Coverage
👁 Documentation
Installation
The best way to install s9e\TextFormatter is via Composer. See Installation.
composer require s9e/text-formatter
Examples
If you can only read one example, read how to use a bundle.
You can run the scripts directly from the examples directory and you will find in the manual a description of each plugin as well as other examples.
Versioning
Versioning is meant to follow Semantic Versioning. You can read about API changes in the documentation.
Online demo
You can try the JavaScript version in this BBCodes + other stuff demo, or this Markdown + stuff (Fatdown) demo.
Development tools
The following tools are used during development.
- phpunit/phpunit 9.6.20 runs a full suite of tests before every commit.
- code-lts/doctum 5.5.4 generates the API docs.
- Scrutinizer is used for code tracking.