PHPackages                             bolt/article - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility & Helpers](/categories/utility)
4. /
5. bolt/article

ActiveBolt-extension[Utility & Helpers](/categories/utility)

bolt/article
============

📝 Bolt Extension to add the Article FieldType

3.0.1(5mo ago)11131.7k↓26.2%111MITPHPPHP >=8.2CI passing

Since Aug 5Pushed 4mo ago8 watchersCompare

[ Source](https://github.com/bolt/article)[ Packagist](https://packagist.org/packages/bolt/article)[ RSS](/packages/bolt-article/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (10)Dependencies (6)Versions (46)Used By (1)

📝 Bolt Article Extension
========================

[](#-bolt-article-extension)

This extension provides a "Article" field type, which is a powerful text editor for creating rich content in your [Bolt](https://boltcms.io) websites. It can work with grids, embeds, typographic markup and media. The editor itself is developed by [Imperavi](https://imperavi.com/article/), and is licensed for usage in Bolt.

This extension allows you to add fields of `type: article` in your ContentTypes, as defined in `contenttypes.yaml`, like any other Field type.

Installation
------------

[](#installation)

Note: Installation is not required if you've installed the default Bolt project. In that case it's already present. If you've installed Bolt through different means, you'll need to run the command below:

```
composer require bolt/article
```

After installation, you can add it to any ContentType in your `contenttypes.yaml`, like any other field. For example:

```
blogposts:
    name: Blogposts
    singular_name: Blogpost
    fields:
        title:
            type: text
        slug:
            type: slug
            uses: title
        content:
            type: article
```

The result will be like this:

[![](https://user-images.githubusercontent.com/1833361/90976496-ecfd2400-e53d-11ea-8f15-037c97238785.png)](https://user-images.githubusercontent.com/1833361/90976496-ecfd2400-e53d-11ea-8f15-037c97238785.png)

You can configure the editor in `config/extensions/bolt-article.yaml`. This configuration affects all the instances of the Article field that you've configured in your ContentTypes. The default configuration looks like this:

```
# Settings for Bolt Article

default:
  plugins: [ blockcode, buttonlink, definedlinks, inlineformat, reorder, tags, underline ]
  source: true
  grid:
    classname: 'article-grid'
    columns: 12
    patterns:
      '4|4|4': 'col-4|col-4|col-4'
      '4|8': 'col-4|col-8'
      '6|6': 'col-6|col-6'
      '8|4': 'col-8|col-4'

plugins:
  ~
```

Configuring the buttons
-----------------------

[](#configuring-the-buttons)

Bolt's version of Article ships with all the official plugins and options. you can add or remove buttons and plugins by configuring them in the `plugins:`parameters. Check the official Article documentation for [all available buttons](https://imperavi.com/article/docs/get-started/). Note that some buttons might require you to enable the corresponding plugin as well. See here for a list of [the available plugins](https://imperavi.com/article/plugins/).

Settings
--------

[](#settings)

Where applicable, you can add extra settings under the `default:` key in the `bolt-article.yaml` configuration. See the documentation for available settings.

Note that this documentation uses Javascript, whilst Bolt's configuration uses Yaml. For example, the documentation for '[Paste](https://imperavi.com/article/docs/settings/paste/)' has this example:

```
ArticleEditor('#entry', {
    css: '/your-article-dist-path/',
    paste: {
        autolink: false
    }
});
```

In `bolt-Article.yaml` you can add this as:

```
default:
  buttons: [ …]
  plugins: [ … ]
  css: '/your-article-dist-path/'
  paste:
    autolink: false
```

Adding custom plugins
---------------------

[](#adding-custom-plugins)

If you've written your own block or plugin for Article according to the documentation [for Creating Plugins](https://imperavi.com/article/docs/how-to-create-a-plugin/) or [for Creating Blocks](https://imperavi.com/article/docs/how-to-create-a-custom-block/), you can add it to the editor in Bolt, by placing it in `/public/assets/article/_plugins`. Then, add it to the `bolt-article.yaml` configuration:

```
default:
  buttons: [ … ]
  plugins: [ … ]

plugins:
  myplugin: [ 'myplugin/myplugin.js', 'myplugin/myplugin.css' ]
```

Grid setup
----------

[](#grid-setup)

Using Article, you can allow the editors to insert Grid elements, splitting up the "main column" in two or more columns, allowing them more variations for laying out content.

By default, Article has a simple grid that consists of 12 columns, and allows the editors to pick '4 + 4 + 4', '4 + 8', '6 + 6' and '8 + 4' as options. The grid will create HTML like this:

```

    …

    …

```

On the front end of the website, this needs to be styled correctly as CSS, in order to work properly. This can be done in a few ways:

1. Linking to the default styles.
2. Copy the `grid.css` file to your theme to customize it.
3. Manually styling the grid, using your own CSS.

You can link the `grid.css` that ships with Article using the following:

```

```

If you prefer to copy the file to your own theme, you can link it using:

```

```

Alternatively, if your theme is using Bootstrap or Bulma, you can configure Article to use the grid format from your preferred framework directly. See the documentation on [using Bootstrap grid](https://imperavi.com/article/examples/frameworks/bootstrap-grid/) or [using Bulma grid](https://imperavi.com/article/examples/frameworks/bulma-grid/).

---

The part below is only for *developing* the extension. Not required for general usage of the extension in your Bolt Project

Running PHPStan and Easy Codings Standard
-----------------------------------------

[](#running-phpstan-and-easy-codings-standard)

First, make sure dependencies are installed:

```
COMPOSER_MEMORY_LIMIT=-1 composer update
```

And then run ECS:

```
vendor/bin/ecs check src --fix
```

###  Health Score

59

—

FairBetter than 99% of packages

Maintenance73

Regular maintenance activity

Popularity41

Moderate usage in the ecosystem

Community27

Small or concentrated contributor base

Maturity80

Battle-tested with a long release history

 Bus Factor1

Top contributor holds 63.5% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~44 days

Recently: every ~267 days

Total

45

Last Release

161d ago

Major Versions

0.0.2 → 1.0.02020-08-17

1.1.0 → 2.0.02021-08-19

2.1.5 → 3.0.02025-12-01

PHP version history (2 changes)0.0.1PHP >=7.2.9

3.0.0PHP >=8.2

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/1835343?v=4)[Bob van de Vijver](/maintainers/bobvandevijver)[@bobvandevijver](https://github.com/bobvandevijver)

![](https://avatars.githubusercontent.com/u/3901745?v=4)[Tobias Feijten](/maintainers/tobias-93)[@tobias-93](https://github.com/tobias-93)

![](https://avatars.githubusercontent.com/u/1833361?v=4)[Bob den Otter](/maintainers/bobdenotter)[@bobdenotter](https://github.com/bobdenotter)

---

Top Contributors

[![bobdenotter](https://avatars.githubusercontent.com/u/1833361?v=4)](https://github.com/bobdenotter "bobdenotter (80 commits)")[![bobvandevijver](https://avatars.githubusercontent.com/u/1835343?v=4)](https://github.com/bobvandevijver "bobvandevijver (23 commits)")[![I-Valchev](https://avatars.githubusercontent.com/u/7093518?v=4)](https://github.com/I-Valchev "I-Valchev (16 commits)")[![LeoHugues](https://avatars.githubusercontent.com/u/11269502?v=4)](https://github.com/LeoHugues "LeoHugues (1 commits)")[![LordSimal](https://avatars.githubusercontent.com/u/9105243?v=4)](https://github.com/LordSimal "LordSimal (1 commits)")[![nestordedios](https://avatars.githubusercontent.com/u/6607455?v=4)](https://github.com/nestordedios "nestordedios (1 commits)")[![SweersJ](https://avatars.githubusercontent.com/u/113710099?v=4)](https://github.com/SweersJ "SweersJ (1 commits)")[![Thibault-MTZ](https://avatars.githubusercontent.com/u/12842485?v=4)](https://github.com/Thibault-MTZ "Thibault-MTZ (1 commits)")[![develth](https://avatars.githubusercontent.com/u/3374563?v=4)](https://github.com/develth "develth (1 commits)")[![Filoz](https://avatars.githubusercontent.com/u/5341996?v=4)](https://github.com/Filoz "Filoz (1 commits)")

###  Code Quality

Static AnalysisPHPStan, Rector

Code StyleECS

Type Coverage Yes

### Embed Badge

![Health badge](/badges/bolt-article/health.svg)

```
[![Health](https://phpackages.com/badges/bolt-article/health.svg)](https://phpackages.com/packages/bolt-article)
```

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)