README

Typographer is a plugin that offers methods to apply advanced typographic rules to your content. Besides handling common cases like quotes, apostrophes or dashes out of the box, it allows for the creation of custom corrections and helps to typeset your content inside your templates and snippets smoothly.

Tip

Oh, hi, long time no see 👋 Typographer has been around for a long time but you’ve only ever seen version 0.2. This is version 4.0. Yes, that’s right. Things have changed, please do not directly update in case you used the old version before. Read the docs to see what changed first.

If you need DOM manipulation, please check out our new Designer plugin.

More than just smart pants.

Consistency and professional tone made easy and efficient for your editors: Fine-tune your Typographer setup with custom corrections to work hand-in-hand with an established style guide.

Learn more about custom corrections.

Hallo Welt! Hei verden! Merhaba dünya!

Of international interest: Typographer currently bundles typographic rules for 70 locales. C’est génial, n’est-ce pas?

Browse The Long List of Languages.

Included corrections

Typographer bundles a set of corrections that can be applied individually. If no corrections are applied, Typographer will back to following default set:

In addition to these defaults, there are several optional corrections that can be applied manually:

[!important] Please note that this plugin makes use of the latest Dom additions in PHP 8.4 and their extensions in PHP 8.5. Thus PHP 8.5 is a requirement for this plugin.

Installation

By default, plugins in Kirby reside in a special folder located at /site/plugins. Each plugin is installed in its proprietary subfolder. This installation can be handled in four different ways: you can either install them manually or manage them using Kirby CLI, Git submodules or Composer. You can install Typographer either way and should choose the method suiting your project best.

Please note that all examples given here assume you are using the default plugin root. If you changed your plugin root, e. g. with a custom folder setup, you’ll also have to adjust the paths given in this guide. For further information on how to manage plugins, please read the official Kirby plugin introduction.

Download

Download and copy this repository to /site/plugins/typographer.

Kirby CLI

kirby plugin:install hananils/kirby-typographer

Git submodule

git submodule add \
    https://github.com/hananils/kirby-typographer.git \
    site/plugins/typographer

Composer

composer require hananils/kirby-typographer

Documentation

Where possible, files contain inline annotations. For extended documentation, please visit our dedicated plugin site at kirby.hananils.de/plugins/typographer.

Guides

Reference

License

This plugin is provided freely under the MIT license by hana+nils · Büro für Gestaltung. We create visual designs for digital and analog media.

hananils / kirby-typographer

Package info

Security

Statistics