PHPackages                             phpdocumentor/guides-djot - 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. phpdocumentor/guides-djot

ActiveLibrary[Utility & Helpers](/categories/utility)

phpdocumentor/guides-djot
=========================

Djot markup support for phpDocumentor's Guides library

1.0.0(5mo ago)01MITPHPPHP ^8.2

Since Dec 13Pushed 5mo agoCompare

[ Source](https://github.com/phpDocumentor/guides-djot)[ Packagist](https://packagist.org/packages/phpdocumentor/guides-djot)[ Docs](https://github.com/phpDocumentor/guides-djot)[ RSS](/packages/phpdocumentor-guides-djot/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (1)Dependencies (7)Versions (3)Used By (0)

Djot Support for phpDocumentor Guides
=====================================

[](#djot-support-for-phpdocumentor-guides)

This package adds [Djot](https://djot.net) markup language support to phpDocumentor's Guides library.

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

[](#installation)

```
composer require phpdocumentor/guides-djot
```

Requirements
------------

[](#requirements)

- PHP 8.2+
- [php-collective/djot](https://github.com/php-collective/djot-php) ^0.1.8
- [phpdocumentor/guides](https://github.com/phpDocumentor/guides) ^1.0

Usage
-----

[](#usage)

Once installed, the package automatically registers Djot as a supported input format. You can then use `.djot` files in your documentation.

### Basic Example

[](#basic-example)

Create a file `docs/index.djot`:

```
# Welcome to My Project

This is documentation written in _Djot_ markup.

## Features

- *Strong* and _emphasis_ formatting
- {=Highlighted=} text
- Code blocks with syntax highlighting

```php
echo "Hello, World!";

```

Links
-----

[](#links)

See the [official Djot spec](https://djot.net) for full syntax reference.

```

### Symfony Integration

If you're using Symfony, register the extension in your services:

```yaml
# config/services.yaml
services:
    phpDocumentor\Guides\Djot\DependencyInjection\DjotExtension:
        tags: ['kernel.extension']

```

Or load it programmatically:

```
use phpDocumentor\Guides\Djot\DependencyInjection\DjotExtension;

$extension = new DjotExtension();
$extension->load([], $containerBuilder);
```

Supported Djot Features
-----------------------

[](#supported-djot-features)

Djot FeatureGuides NodeHeadings`TitleNode`Paragraphs`ParagraphNode`Code blocks`CodeNode`Block quotes`QuoteNode`Lists (ordered/unordered)`ListNode`Task lists`ListNode` with checkboxesTables`TableNode`Definition lists`DefinitionListNode`Thematic breaks`SeparatorNode`Images`ImageNode` / `FigureNode`Links`HyperLinkNode`Strong/Emphasis`StrongInlineNode` / `EmphasisInlineNode`Inline code`LiteralInlineNode`Highlight/Insert/Delete`GenericTextRoleInlineNode`Superscript/Subscript`GenericTextRoleInlineNode`Footnotes`FootnoteNode`Math`GenericTextRoleInlineNode`Raw blocks`RawNode`Divs`SectionNode`Why Djot?
---------

[](#why-djot)

Djot is a modern markup language created by John MacFarlane (author of Pandoc and CommonMark). It offers:

- **Predictable parsing** - No backtracking or context-dependent rules
- **Built-in features** - Highlights, insertions, deletions, attributes on any element
- **Clear syntax** - `_emphasis_` vs `*strong*` (not ambiguous like Markdown)
- **Single specification** - No "flavors" to worry about

See the [djot-php documentation](https://github.com/php-collective/djot-php) for more information.

License
-------

[](#license)

MIT License - see [LICENSE](LICENSE) for details.

###  Health Score

34

—

LowBetter than 77% of packages

Maintenance72

Regular maintenance activity

Popularity1

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity48

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% 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

Unknown

Total

1

Last Release

157d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/471baf346b526fa9e1259ee3d577b1dd72fbb45337b495d5475f87ba063490cb?d=identicon)[jaapio](/maintainers/jaapio)

![](https://avatars.githubusercontent.com/u/39854?v=4)[Mark Scherer](/maintainers/dereuromark)[@dereuromark](https://github.com/dereuromark)

---

Top Contributors

[![dereuromark](https://avatars.githubusercontent.com/u/39854?v=4)](https://github.com/dereuromark "dereuromark (8 commits)")

---

Tags

documentationphpDocumentormarkupdjotguides

###  Code Quality

TestsPHPUnit

Static AnalysisPHPStan

Type Coverage Yes

### Embed Badge

![Health badge](/badges/phpdocumentor-guides-djot/health.svg)

```
[![Health](https://phpackages.com/badges/phpdocumentor-guides-djot/health.svg)](https://phpackages.com/packages/phpdocumentor-guides-djot)
```

###  Alternatives

[civicrm/civicrm-core

Open source constituent relationship management for non-profits, NGOs and advocacy organizations.

728272.9k20](/packages/civicrm-civicrm-core)[codefog/contao-haste

haste extension for Contao Open Source CMS

42650.8k139](/packages/codefog-contao-haste)[symfony/ai-bundle

Integration bundle for Symfony AI components

30282.3k6](/packages/symfony-ai-bundle)[spomky-labs/pwa-bundle

Progressive Web App Manifest Generator Bundle for Symfony.

6144.4k1](/packages/spomky-labs-pwa-bundle)[symfony/ux-cropperjs

Cropper.js integration for Symfony

19280.3k3](/packages/symfony-ux-cropperjs)

PHPackages © 2026

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