Download the PHP package rakib01/laravel-model-docs-md without Composer
On this page you can find all versions of the php package rakib01/laravel-model-docs-md. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download rakib01/laravel-model-docs-md
More information about rakib01/laravel-model-docs-md
Files in rakib01/laravel-model-docs-md
Package laravel-model-docs-md
Short Description Generate Markdown documentation for all Eloquent models in Laravel.
License MIT
Homepage https://github.com/Rakib01/laravel-model-docs-md
FAQ
Example:
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 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.
Informations about the package laravel-model-docs-md
📘 Laravel Model Docs MD
A Laravel package that automatically generates Model Documentation in Markdown format (.md). Perfect for documenting your application's Eloquent models — their attributes, relationships, casts, and more.
🚀 Features
- 📄 Generate Markdown documentation for all Eloquent models in one file
- ⚙️ Configurable output directory and formatting
- 🧠 Detects attributes, relationships, casts, fillable, hidden, and appended fields
- 🕹️ Simple Artisan command
- 🧩 Fully open-source and easy to extend
🧪 Installation
Require the package via Composer:
⚙️ Publish Configuration
You can publish the configuration file using:
This will publish a config file at:
🧾 Generate Model Documentation
Once installed, simply run:
This command will inspect all models in your app/Models directory and generate a single file named:
storage/app/model-docs.md
Each model will be represented as a section in the file, similar to this:
🧩 App\Models\User
Table: users
Columns:
| Name | Type | Cast |
|---|---|---|
| id | bigint | int |
| name | varchar | - |
| varchar | - | |
| password | varchar | - |
Fillable: name, email, password
Hidden: password, remember_token
Appends: is_verified
Relationships:
- posts → Post
All models will be appended sequentially in this same Markdown file — allowing you to have a complete model documentation in one place.
🛠️ Requirements
- PHP >= 8.1
- Laravel >= 12.x or 11.x, 10.x
🤝 Contributing
Pull requests are welcome! If you find a bug or have a feature request, please open an issue on GitHub Issues.
📄 License
This package is open-sourced software licensed under the MIT license.
Created with ❤️ by Rakibul Hasan
