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.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

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

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

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:

Testing

License

MIT


All versions of filament-docs with dependencies

PHP Build Version
Package Version
Requires php Version ^8.2
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
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package wezlo/filament-docs contains the following files

Loading the files please wait ...