Download the PHP package wezlo/filament-docs without Composer
On this page you can find all versions of the php package wezlo/filament-docs. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download wezlo/filament-docs
More information about wezlo/filament-docs
Files in wezlo/filament-docs
Package filament-docs
Short Description Multi-locale markdown documentation viewer for Filament — devs commit .md files, panel users read them with sidebar TOC, search, and locale switcher.
License MIT
Informations about the package filament-docs
wezlo/filament-docs
Multi-locale markdown documentation viewer for Filament. Devs commit .md
files to git, panel users read them with a sidebar TOC, full-text search,
in-page locale switcher, and copy-to-clipboard code blocks.
This is prose docs (guides, how-tos, FAQs) — not auto-generated reference.
For schema-introspection docs, see wezlo/filament-auto-docs.
Install
Register the plugin on your panel:
Tell Tailwind about the package's views (custom themes only)
The package's prose CSS and copy-button JS load automatically via
FilamentAsset::register() — nothing to wire up there. But the shipped
Blade views use Tailwind utility classes for layout (grid, spacing,
dark-mode), and if you use a custom Filament theme, Tailwind will purge those
classes unless the package's views are in your theme's @source paths.
Add this line to your panel's theme file:
Then rebuild:
If you're on the default Filament theme (no viteTheme(...) on the panel),
skip this step.
Author docs in markdown
- Numeric prefix (
01-,02-) controls order, stripped from titles. - Folders become sections in the sidebar.
- Optional YAML frontmatter (
title:,icon:). - Missing translations fall back to the default locale with a banner.
Localising section titles
Folder names are English-by-convention (02-orders, site-panel,
workforce), so the sidebar and breadcrumbs need explicit translations for
each section. There are two ways:
Option 1 — single resources/docs/_config.php (recommended):
Option 2 — per-locale _section.yml (one per locale folder, useful
when content teams own translations independently):
Both title and icon accept either a plain string or a locale-keyed map.
Missing locales fall back to the default locale, then to
Str::headline(folderName).
Article titles are taken from the markdown's first # Heading (or
frontmatter title:) and so are localised automatically by writing the
markdown in each locale's tree.
Features
- Sidebar TOC + breadcrumbs (auto-built from filesystem)
- Full-text search across all locales (toggle "Search all languages")
- In-page locale switcher with automatic RTL for
ar/he/fa/ur - GFM tables, task lists, fenced code, autolinks
- Heading anchors for deep-linking
- Copy-to-clipboard buttons on every code block
- File-mtime-keyed search cache (auto-invalidates on content changes)
Architecture
Custom doc sources
Implement Wezlo\FilamentDocs\Contracts\DocSource and bind in a service
provider — useful for DB-backed docs, S3-stored markdown, etc.
Commands
| Command | Purpose |
|---|---|
php artisan filament-docs:install |
Scaffold sample docs into resources/docs/. |
php artisan filament-docs:index [--force] |
Rebuild the search index. |
Configuration
Published to config/filament-docs.php. Key options:
content_path,default_locale,locales,rtl_localesroute.slug,navigation.{group, icon, sort}search.{enabled, max_results, snippet_length, min_length}markdown.{gfm, heading_anchors}
Testing
License
MIT
All versions of filament-docs with dependencies
filament/filament Version ^4.0 || ^5.0
league/commonmark Version ^2.4
spatie/laravel-package-tools Version ^1.0
symfony/yaml Version ^6.0 || ^7.0 || ^8.0