Download the PHP package georgringer/doc without Composer

On this page you can find all versions of the php package georgringer/doc. 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 doc

TYPO3 Extension doc

This extension adds an option to the Help menu called Project Documentation, that lets you deliver documentation about your project from within TYPO3 CMS backend.

The extension also ships with a widget for the TYPO3 Dashboad extension to give you quick access to your project documentation.

The documentation is based on Markdown. This makes it easy to write documentation while you're building a custom extension, or afterward. You could include descriptions of content elements, release notes, instructions for raising issues or anything else that needs to be documented.

The JS library docsify transforms markdown files into beautiful HTML content.

Setup the extension

Download the extension. Use one of the following options:

  1. Composer: composer req georgringer/doc
  2. TER: Download extension from TER
  3. TYPO3 Backend: Download extension in Extension Manager

Configuration

Switch to Install Tool/Settings and customize the global configuration. As seen in the screenshot below, the following configuration options are available:

Write the documentation

Without any documentation, this extension is not useful at all :)

Check out the sample documentation included in this extension which you can use as a guide EXT:doc/Resources/Private/ExampleDocs. See also the Markdown Cheatsheet as there are some nice features available.

When you create your own documentation make sure to put the folder with your markdown files in Resources/Private. Otherwise your markdown files may be publicly accessible.

All versions of doc with dependencies

PHP Build Version
Package Version
Requires typo3/cms-core Version ^9 || ^10 || ^11
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 georgringer/doc contains the following files

Loading the files please wait ....