Download the PHP package hkod/frontmatter without Composer
On this page you can find all versions of the php package hkod/frontmatter. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download hkod/frontmatter
More information about hkod/frontmatter
Files in hkod/frontmatter
Package frontmatter
Short Description A context aware frontmatter parser that supports multiple formats and uses a clean OOP architecture
License Unlicense
Homepage https://github.com/hanneskod/frontmatter
FAQ
Example:
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 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.
Informations about the package frontmatter
frontmatter
A context aware frontmatter parser that supports multiple formats and uses a clean OOP architecture.
Front matter is metadata located at the top of a file wrapped in delimiting
line tokens, usually ---. The front matter may be formatted using YAML, Json
or any ohter simliar format such as NEON or TOML.
Supported formats:
- Json
- INI
- YAML (
require symfony/yaml) - Markdown (
require erusev/parsedown) - Mustache (
require mustache/mustache)
Parsers are simple callables, super easy to add more formats.
Installation
Usage
A standard parser with yaml frontmatter and markdown body:
Specify the front matter delimiter
Note that the delimiting tokens always represents full lines.
You may set the delimiters when creating the block parser.
Putting the frontmatter last
Note that since the delimiting tokens represent a line the last line must end whit a new line (or similar) or it won't be recognized by the parser.
Frontmatter also supports an inverted block parser, where the frontmatter is expected to bee last instead of first.
Passing a context
When parsing you may pass a context to the parser and it will in turn be passed along to all subsequent parsers. Context dependet parsers may for example expand templates...
