Download the PHP package linchpin/phpdocumentor-markdown-template without Composer

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

phpDocumentor - Generate GitHub/GitLab-Ready Markdown Documentation

Markdown template for phpDocumentor 3.x

Tests Status Generate Docs Status

Have you ever wished there was an easier way to generate documentation for your PHP source code? Well, now there is! With phpDocumentor and phpDocumentor-markdown, you can automatically generate GitHub/GitLab-ready Markdown documentation from your PHP source code. This template can be used to document classes, interfaces, traits, constants, properties and methods.

Example

An example is available in the example directory.

Installation & Usage

Running manually

Using Composer

Installation via Composer

Running manually after installing via Composer

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.

Running tests

Contributing

Originally forked from : Saggre/phpDocumentor-markdown


All versions of phpdocumentor-markdown-template 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 linchpin/phpdocumentor-markdown-template contains the following files

Loading the files please wait ....