Download the PHP package aw-studio/docdress without Composer

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

Docdress

A package to create markdown documentations from GitHub repositories in your Laravel project. Easy editing for contributors.

The example image shows the litstack documenation. The GitHub repository can be found under litstack/litstack.io.

Table Of Contents

Introduction

With Docdress you can turn your project/package documentation within minutes into a web interface with a Laravel-like design.

Docdress offers the following features:

Setup

Install Docdress via composer:

Now publish the required assets and the config:

You may also publish the config or assetsonly like this:

Add repository to Config

Add the desired repository to the docdress config.

Clone repository

Once you have configured the repository, you must clone it using docdress:clone:

Structure

Readme.md

The index is built as a nested list in the readme.md. It is located under ## Index. So your readme.md could look like this:

Table of Contents

The table of contents is built from all ## and ### headings under the # heading. No link tag with a nameattribute is needed. You can easily build your markdown file as follows:

Configuration

With Docdress any number of repositories can be documented in one laravel project. Each repository is configured in docdress.repos like so:

The following attributes can be configured for a repository:

Some of the attributes are discussed in more detail below:

Versions

Every version is representing a branch. Set the default_version to your default branch. The versions are specified as branch name and title, like so:

Private repositories

Private repositories require a personal access token with the read permissions for the repository.

Subfolder

You may have the documentation of a project or a package in a subfolder of the corresponding repository. If a subfolder is specified in the config, only this folder is cloned and displayed.

Webhook

If you want the latest version to be automatically updated with every push, you have to set a webhook with the url _docdress/update.

Additionally the Content-Type must be set to application/json.

And the token from your config must be specified.

Algolia

Algolia Docsearch can be used for the search of your documenation. All you have to do is to specify your application key for the respective repository.

Authorization

You may create gate for a repository in the boot method of your AuthServiceProvider to manage access to the documentation.

Alerts

You may display alerts just like custom-blocks in vuepress. The available alert types are tip, warning, danger

Search Component

By using the x-dd-search-input component. You can place the algolia search input in your blade views. The component needs the repo that should be searched and the desired version.

Testing

Execute tests via composer:


All versions of docdress with dependencies

PHP Build Version
Package Version
Requires erusev/parsedown-extra Version ^0.8.1
cbl/blade-style Version ^1.0
cbl/blade-script Version ^1.0
symfony/browser-kit Version ^5.1
laravel/scout Version ^8.2
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 aw-studio/docdress contains the following files

Loading the files please wait ....