Download the PHP package bluegg/websitedocumentation without Composer

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

Website Documentation plugin for Craft CMS 5.x

Creates two links within admin for Style Guide and CMS Guide

Requirements

This plugin requires Craft CMS 5+.

Installation

To install the plugin, follow these instructions.

  1. Open your terminal and go to your Craft project:

  2. Then tell Composer to load the plugin:

  3. In the Control Panel, go to Settings → Plugins and click the “Install” button for Website Documentation.

Usage

Installing Demo Templates

Once the plugin has installed you will see a new menu item called Documentation.

If you go to Plugin Settings -> Install Templates and click install, this will copy the default guides to your templates folder.

Within this folder you can go to Layouts -> CMS Guide / Styleguide and update the paths to where your CSS and JS live.

General Settings

Within General Settings you can add a logo, and choose colours which will be displayed across both Style and CMS Guides.

CMS Guide Settings

Here you can create the structure for your CMS Guide and add some default entries to get you started.

Adding new sections to the styleguide

If you're using the demo templates, you can add a new section by opening up the _config.twig file and adding new items to the Object. Each item can have a Sub menu as well.

The naming of these items are used in kebab case for the file in the sections folder. For example if you call a section Heroes you'll name your file heroes.twig.

Toward Disclaimer

Brought to you by Toward

All versions of websitedocumentation with dependencies

PHP Build Version
Package Version
Requires craftcms/cms Version ^5.0.0
craftcms/ckeditor Version ^4
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 bluegg/websitedocumentation contains the following files

Loading the files please wait ....