Download the PHP package saeedvir/laravel-project-markdown without Composer

On this page you can find all versions of the php package saeedvir/laravel-project-markdown. 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?

Example code of saeedvir/laravel-project-markdown

Informations about the package laravel-project-markdown

Laravel Project Markdown

Latest Version Laravel PHP

A comprehensive Laravel package that provides artisan commands to generate detailed markdown documentation for your project files and database schema. Perfect for developers, teams, and AI systems that need to understand your Laravel project structure.

🚀 Features

📁 Project Files Documentation

🗄️ Database Documentation

🤖 AI Readable Documentation

📦 Installation

Via Composer (Recommended)

Local Development Installation

  1. Add path repository to your Laravel project's composer.json:

  2. Install the package:

  3. Publish configuration (optional):

⚙️ Configuration

The package includes a comprehensive configuration file at config/laravel-project-markdown.php:

🎯 Usage

Project Files Documentation

Generate comprehensive documentation for your project files:

Command Options

Option Description Default
path Project path to analyze base_path()
--output Output markdown file path storage/app/project-structure.md
--exclude Additional directories to exclude []
--depth Maximum directory depth PHP_INT_MAX

Examples

Database Documentation

Generate comprehensive database schema documentation:

Command Options

Option Description Default
--path Output file path database.md

Examples

📊 Generated Documentation

Files Documentation Output

The files documentation includes:

  1. Project Overview

    • Project name and type
    • Generation timestamp
    • Version information (Laravel, PHP, Database)

  2. Composer Packages

    • All installed packages with versions
    • Laravel discoverable packages
    • Service providers and aliases

  3. Project Structure

    • Hierarchical file tree
    • File sizes and modification dates
    • Directory organization
  4. JSON Metadata
    • Machine-readable project information
    • Complete package list
    • File structure data

Database Documentation Output

The database documentation includes:

  1. Database Overview

    • Database name and type
    • Version information
    • Generation timestamp

  2. ER Diagram

    • Mermaid-compatible diagram
    • Color-coded tables
    • Relationship connections

  3. Table Details

    • Column specifications
    • Data types and constraints
    • Indexes and foreign keys
    • Sample data queries
  4. JSON Schema
    • Complete database structure
    • Relationship mappings
    • Metadata for AI processing

🤖 AI Readable Documentation

This package is specifically designed to generate documentation that is both human-readable and AI-processable:

Structured JSON Output

Every command generates a corresponding JSON file with structured data:

AI Processing Benefits

Use Cases for AI Systems

  1. Code Analysis: AI can understand project structure and dependencies
  2. Documentation Generation: Automated documentation creation
  3. Migration Planning: Database schema analysis for migrations
  4. Dependency Management: Package analysis and updates
  5. Project Onboarding: Quick project understanding for new developers

🔧 Advanced Configuration

Custom Exclude Patterns

Database Connection Settings

The database command automatically uses your Laravel database configuration. Ensure your .env file has proper database settings:

📋 Requirements

🧪 Testing

Run the test suite:

📈 Examples

Example 1: Basic Project Analysis

Example 2: Database Schema Documentation

Example 3: Custom Analysis

🤝 Contributing

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add some amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

📝 Changelog

[1.0.0] - 2025-09-20

Added

Features

📄 License

This package is open-sourced software licensed under the MIT license.

👨‍💻 Author

Saeedvir

Made with ❤️ for the Laravel community

All versions of laravel-project-markdown with dependencies

PHP Build Version
Package Version
Requires php Version ^8.1
illuminate/support Version ^10.0|^11.0|^12.0
illuminate/console Version ^10.0|^11.0|^12.0
illuminate/database Version ^10.0|^11.0|^12.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 saeedvir/laravel-project-markdown contains the following files

Loading the files please wait ...