PHPackages                             eightynine/filament-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. [Search & Filtering](/categories/search)
4. /
5. eightynine/filament-docs

ActiveLibrary[Search & Filtering](/categories/search)

eightynine/filament-docs
========================

Elegant documentation system for your Filament application with search, navigation, and markdown support

3.0.1(10mo ago)122.5k↓13.9%1[1 issues](https://github.com/eighty9nine/filament-docs/issues)1MITPHPPHP ^8.2

Since Jun 22Pushed 9mo agoCompare

[ Source](https://github.com/eighty9nine/filament-docs)[ Packagist](https://packagist.org/packages/eightynine/filament-docs)[ Docs](https://github.com/eightynine/filament-docs)[ RSS](/packages/eightynine-filament-docs/feed)WikiDiscussions 3.x Synced 1mo ago

READMEChangelog (2)Dependencies (10)Versions (3)Used By (1)

Filament Docs
=============

[](#filament-docs)

[![Latest Version on Packagist](https://camo.githubusercontent.com/f434371655f7d93e87e70dc478f63fa43f01320a0631300540bab9b395c3366f/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f6569676874796e696e652f66696c616d656e742d646f63732e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/eightynine/filament-docs)[![Total Downloads](https://camo.githubusercontent.com/fc7842d8f5bc4c38584452f673b57de32e4dc8352e809ecc961dc19038c56d29/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f6569676874796e696e652f66696c616d656e742d646f63732e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/eightynine/filament-docs)

A Filament plugin for creating elegant documentation pages within your admin panel.

Features
--------

[](#features)

- **Markdown Support**: Full CommonMark compatibility with syntax highlighting
- **Real-time Search**: Instant search with context-aware results
- **Responsive Design**: Mobile-first with dark mode support
- **Multi-language**: Built-in internationalization support
- **Theme Integration**: Seamlessly integrates with Filament themes
- **Artisan Commands**: CLI tools for generating pages and content

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

[](#requirements)

- PHP 8.1+
- Laravel 10.0+
- Filament 3.0+

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

[](#installation)

```
composer require eightynine/filament-docs
```

Publish configuration (optional):

```
php artisan vendor:publish --tag="filament-docs-config"
```

Create documentation directory:

```
mkdir -p resources/docs
```

Quick Start
-----------

[](#quick-start)

1. Create a documentation page:

```
php artisan make:filament-docs-page UserManual \
    --navigation-group="Documentation" \
    --navigation-icon="heroicon-o-book-open"
```

2. Add markdown files to `resources/docs/`:

```
# Getting Started

Welcome to the documentation!
```

3. Access your documentation in the Filament admin panel.

Configuration
-------------

[](#configuration)

The configuration file `config/filament-docs.php` allows customization:

```
return [
    'default_docs_path' => resource_path('docs'),
    'search' => [
        'debounce_ms' => 300,
    ],
    'ui' => [
        'sidebar_width' => 'lg:w-80',
        'default_navigation_group' => 'Documentation',
    ],
];
```

Advanced Usage
--------------

[](#advanced-usage)

### Custom Documentation Page

[](#custom-documentation-page)

```