Download the PHP package saggre/phpdocumentor-markdown without Composer

On this page you can find all versions of the php package saggre/phpdocumentor-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 saggre/phpdocumentor-markdown

Informations about the package phpdocumentor-markdown

phpDocumentor-markdown - Automatically generate Markdown documentation

Use cases: In-repository documentation, GitHub/GitLab wikis, AI prompt context.

Markdown template for phpDocumentor3

Tests Status Generate Docs Status

Wish there was an easy way to generate PHP source code documentation? \ Using phpDocumentor with phpDocumentor-markdown template, you can automatically generate GitHub/GitLab-ready Markdown documentation from PHP source code.

This template can be used to document:

Name Descriptions Inheritance Implements Constants Properties Methods Inherited methods
Classes ✅ ✅ ✅ ✅ ✅ ✅ ✅ ✅
Interfaces ✅ ✅ ✅ ➖ ✅ ✅ ✅ ➖
Traits ✅ ✅ ➖ ➖ ✅ ✅ ✅ ➖
Name Descriptions Types (parameter, return, etc.) Access modifiers
Functions ✅ ✅ ✅ ✅
Methods ✅ ✅ ✅ ✅
Properties ✅ ✅ ✅ ✅

Example

Examples are available in the .wiki directory.

Installation & Usage

Running manually

Using Composer

Installation via Composer

Running manually after installing via Composer

Installation & Usage tips

Adding a Composer helper script

Add this script to your composer.json and run composer create-docs to generate the documentation.

Using with PhpDocumentor XML config

Add a template element to your phpDocumentor XML config and run phpDocumentor to generate the documentation.

You can also check out the config file used for generating this repository's example documentation for a full example.

GitLab wiki

The output of this template can be used directly as a GitLab wiki.

GitHub wiki

⚠️ GitHub wiki uses a flat directory structure for linking, so the internal links in the resulting documentation will not work as expected.

CI pipelines

You can use the PhpDocumentor Docker image with this template in your CI pipelines to generate documentation automatically.

AI integration

The generated documentation can be used as prompt context for AI models that work with source code. For other use cases you'll likely want structured data, like JSON.

Running tests

Contributing

Inspired by:

All versions of phpdocumentor-markdown with dependencies

PHP Build Version
Package Version
No informations.
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 saggre/phpdocumentor-markdown contains the following files

Loading the files please wait ....