PHPackages                             marko/docs - 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. marko/docs

ActiveMarko-module[Utility & Helpers](/categories/utility)

marko/docs
==========

Documentation search contract for Marko Framework

0.8.4(1mo ago)0134MITPHPPHP ^8.5

Since May 29Pushed 1mo agoCompare

[ Source](https://github.com/marko-php/marko-docs)[ Packagist](https://packagist.org/packages/marko/docs)[ RSS](/packages/marko-docs/feed)WikiDiscussions develop Synced 1w ago

READMEChangelogDependencies (4)Versions (7)Used By (4)

marko/docs
==========

[](#markodocs)

Documentation search contract for Marko — defines the interface for querying Marko documentation, with interchangeable driver implementations.

Overview
--------

[](#overview)

`marko/docs` is the contract package that defines how Marko documentation is searched. It ships no search implementation — install a driver instead: `marko/docs-fts` for lightweight lexical search (SQLite FTS5). A driver implements `DocsSearchInterface`, so apps depend on the contract and stay decoupled from the backend.

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

[](#installation)

Install a driver (which pulls in this package automatically):

```
composer require marko/docs-fts
```

Or install the contract alone if you are building a custom driver:

```
composer require marko/docs
```

Usage
-----

[](#usage)

```
use Marko\Docs\Contract\DocsSearchInterface;
use Marko\Docs\ValueObject\DocsQuery;

class DocsController
{
    public function __construct(
        private DocsSearchInterface $docs,
    ) {}

    public function search(string $term): array
    {
        return $this->docs->search(new DocsQuery($term, limit: 10));
    }
}
```

Customization
-------------

[](#customization)

Implement `DocsSearchInterface` and register your implementation as a Preference:

```
#[Preference(DocsSearchInterface::class)]
class MyDocsSearch implements DocsSearchInterface
{
    public function search(DocsQuery $query): array { /* ... */ }
    public function getPage(string $id): DocsPage { /* ... */ }
    public function listNav(): array { /* ... */ }
    public function driverName(): string { return 'custom'; }
}
```

Documentation
-------------

[](#documentation)

Full driver comparison and API reference: [marko/docs](https://marko.build/docs/packages/docs/)

###  Health Score

41

—

FairBetter than 87% of packages

Maintenance94

Actively maintained with recent releases

Popularity8

Limited adoption so far

Community13

Small or concentrated contributor base

Maturity45

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

Every ~6 days

Total

5

Last Release

30d ago

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/437029?v=4)[Mark Shust](/maintainers/markshust)[@markshust](https://github.com/markshust)

---

Top Contributors

[![markshust](https://avatars.githubusercontent.com/u/437029?v=4)](https://github.com/markshust "markshust (3 commits)")

###  Code Quality

TestsPest

### Embed Badge

![Health badge](/badges/marko-docs/health.svg)

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

PHPackages © 2026

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