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

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

Informations about the package phpdocumentor-template-markdown

GitHub Wiki-Template for phpDocumentor

Introduction

This is a custom template to use with phpDocumentor.

It is intended to create the code documentation as markdown files, fully compatible to serve as a GitHub Wiki in a GitHub repository of your choice.

Example

You can find a live example in this GitHub repository: zorgch/zorg-code/wiki

Installation

  1. Via composer composer require linchpin/phpdocumentor-template-markdown
  2. Download the latest release

Pre-requisites

Generate GitHub Wiki Markdown from your code

  1. Specifiy this template phpdocumentor-template-markdown while generating your code documentation using phpDocumentor: php ./phpDocumentor.phar -d "/path/to/my/sourcecode" -t "/path/to/local/github-wiki" --template="/vendor/linchpin/phpdocumentor-template-markdown" --cache-folder "/path/to/store/cache" --title "My code project"
    • NOTE: you may get an error at the end of the parsing - which you can just ignore, all work was done: ERROR In PathGenerator.php line 120: Variable substitution in path /namespaces/{{name}}.md failed, variable "name" did not return a value
  2. The target directory /github-wiki consists of various markdown (.md) files now
  3. Review, commit & push your local GitHub Wiki repository changes
  4. Browse to the Wiki on the corresponding GitHub repository to see your code documentation online

Result

Consider that GitHub Wiki pages are in a flat file hierarchy. Fortunately you still can use folders in the repository itself - so you can have a clean structure in the Wiki repository, but when linking between files it must behave like all Wiki pages are in a single, flat hierarchy.

Outputted file hierarchy

The output consists of the following files hierarchy:

GitHub Wiki pages handling

As mentioned, due to GitHub Wiki pages behaving not within any hierarchy, linking between Wiki pages is done...

So use class-MyClass to link to the file /wiki/classes/class-MyClass.md.

Or file-myconfigs.inc.php to link to the file /wiki/files/file-myconfigs.inc.php.md.

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

Loading the files please wait ....