Download the PHP package bitandblack/typorules without Composer
On this page you can find all versions of the php package bitandblack/typorules. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download bitandblack/typorules
More information about bitandblack/typorules
Files in bitandblack/typorules
Package typorules
Short Description Typographic improvements for professional-looking and easy-to-read texts.
License MIT
Homepage https://www.bitandblack.com
Informations about the package typorules
Bit&Black TypoRules
Typographic improvements for professional-looking and easy-to-read texts written in PHP.
TOC
- Installation
- Usage
- Using a single rule
- Using a rule set
- Rules existing
- Rule sets existing
- Customization
- Display and check changes
- Thanks
- Help
Installation
This library is available for the use with Composer. Add it to your project by running $ composer require bitandblack/typorules
.
Usage
The Bit&Black TypoRules library comes with a lot of rules that help achieve a better typography. In addition, there are rule sets providing multiple rules at once.
Using a single rule
A single rule can be used like that:
You can find a similar example under /examples/1-single-rule.php
.
Using a rule set
Using a rule set may look like that:
``
You can find a similar example under /examples/2-rule-set.php
.
Rules existing
Read more about the existing rules under /docs/rules.md.
You can add custom rules by implementing the RuleInterface
.
Rule sets existing
Read more about the existing rule sets under /docs/rulesets.md.
You can use custom rule sets by implementing the RuleSetInterface
.
Customization
You can customize rule sets and add or remove rules by using the withRule
or withoutRule
methods.
If you want to set up a rule set completely by your own, you can use the CustomRuleSet
class.
Display and check changes
Every rule returns a list of violations, and every violation may tell about the exact position of the violation found.
However, in some cases, you probably want to create an exact diff view. This can be done using the CharacterDiff
class. This may look like here:
The HtmlOutput
class, and will decide the output format by itself if you don't set up one of those.
Thanks
Our thanking goes to the contributors of JoliTypo, that have inspired our development of this library.
Help
If you have any questions, feel free to contact us under [email protected]
.
Further information about Bit&Black can be found under www.bitandblack.com.
All versions of typorules with dependencies
bitandblack/composer-helper Version ^1.0
bitandblack/helpers Version ^1.0 || ^2.0