Download the PHP package tinydots/craft-front-matter without Composer

On this page you can find all versions of the php package tinydots/craft-front-matter. 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 craft-front-matter

Front Matter for Craft CMS 3.x

Build Status Scrutinizer Code Quality Code Coverage License

Front Matter allows you to extract YAML data from specially-formatted comments at the top of your twig templates. This is especially useful for including a pattern library inside your Craft CMS project.

Requirements

This plugin requires Craft CMS 3.0.0 or later.

Installation

To install the plugin, follow these instructions.

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

    cd /path/to/project

  2. Then tell Composer to load the plugin:

    composer require tinydots/craft-front-matter

  3. In the Control Panel, go to Settings -> Plugins and click the “Install” button for Front Matter.

Usage

Defining data

You can add YAML metadata to the top of any twig template by surrounding it in {#--- and ---#} tags. Because the YAML data is inside a twig comment, you can still {% include %} and {% embed %} templates as normal, with or without the plugin installed.

Given a _components/link.html template for rendering a link, with the following YAML front matter data:

Accessing data

You can access the YAML data as an array from other templates with craft.frontMatter.parse(template):

Pattern Libraries

The main use-case for embedding YAML data in templates is for creating a style guide or pattern library inside the Craft project itself.

Collections/arrays are available to use as normal so can be used to document the variables the template accepts:

You can output the escaped source of the template without the YAML data, using craft.frontMatter.source(template):

If you use simple strings and arrays as input variables in your template, you can even embed a few examples of the output by passing them back in to a normal {% include %} of the template:

All versions of craft-front-matter with dependencies

PHP Build Version
Package Version
Requires craftcms/cms Version ^3.0.0
mnapoli/front-yaml Version ^1.6
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 tinydots/craft-front-matter contains the following files

Loading the files please wait ....