Download the PHP package ublaboo/anabelle without Composer

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

Website 🚀 contributte.org | Contact 👨🏻‍💻 f3l1x.io | Twitter 🐦 @contributte

Disclaimer

:warning: This project is no longer being maintained.
Composer contributte/anabelle
Version
PHP
License

About

Anabelle is a JSON-RPC API documentation generator. It supports both JSON-RPC and REST architectures and provides an extended Markdown syntax for creating rich, interactive API documentation.

Usage

To install the latest version of contributte/anabelle use Composer.

How to use anabelle

CLI options

Automatically overwrite output directory

Add http auth to generated files

Beware! Anabelle generates by default .html files. If you are using http auth, it generates .php files due to the need of validating http auth headers.

Extended Markdown syntax

#include <file.md>

$variable = <value>

Inline variable usage

$$blockVariable ... $$

Block variable usage

@ <sectionName>:<sectionFile.md>

High-level section definition. This macro available only in index.md file.

@@ <sectionName>:<sectionFile.md>

Method section definition. This macro available only in index.md file.

[File link](foo/bar/data.json)

File link will create a link to file (foo/bar/data.json). The file will be copied to documentation output directory for safety reasons.

Generator workflow

  1. Most important (and only required) file is index.md. In this file, you can use only (different Markdown markup is ignored in index.md):
    • # <h1>
    • ## <h2>
    • #include <file.md>
    • $variable = <value>
    • $$blockVariable ... $$
    • @ <sectionName>:<sectionFile.md>
    • @@ <sectionName>:<sectionFile.md>)
  2. #include macros are replaced
  3. <h1> is used as documentation page title (only the first found one is used)
  4. <h2> can be used wherever you want in the sidebar
  5. @ and @@ sections are rendered in the sidebar nav
  6. Content of @ and @@ sections is rendered into separate files and loaded into the main section detail after clicking particular section link in the nav

Examples

Versions

State Version Branch Nette PHP
dev ^6.0.0 master 3.0+ >=8.1
stable ^5.0.0 master 3.0+ >=8.1

Development

This package was maintained by these authors.

Consider to support contributte development team. Also thank you for using this package.

All versions of anabelle with dependencies

PHP Build Version
Package Version
Requires php Version >=8.1
erusev/parsedown Version ^1.7
symfony/console Version ^5.0|^6.0
matthiasmullie/minify Version ^1.3
nette/utils Version ^3.2.10|^4.0.3
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 ublaboo/anabelle contains the following files

Loading the files please wait ...