API Documentation

AuthorSchema extends BlogPostSchema

Front matter schema interfaces are used by various Hyde components to specify what data they provide or contain. They also serve as a convenient way to see the supported front matter properties.

Tags
see
MarkdownPost

Table of Contents

Constants

AUTHOR_SCHEMA  = ['name' => 'string', 'username' => 'string', 'website' => 'string']
BLOG_POST_SCHEMA  = ['title' => 'string', 'description' => 'string', 'category' => 'string', 'date' => 'string', 'author' => ['string', \Hyde\Markdown\Contracts\FrontMatter\SubSchemas\AuthorSchema::AUTHOR_SCHEMA], 'image' => ['string', \Hyde\Markdown\Contracts\FrontMatter\SubSchemas\FeaturedImageSchema::FEATURED_IMAGE_SCHEMA]]
PAGE_SCHEMA  = [ 'title' => 'string', 'description' => 'string', // For <meta name='description'> values. It is used by the automatic page metadata generator, which reads this value from the front matter. 'canonicalUrl' => 'string', // While not present in the page data as a property, it is used by the accessor method, which reads this value from the front matter. 'navigation' => \Hyde\Markdown\Contracts\FrontMatter\SubSchemas\NavigationSchema::NAVIGATION_SCHEMA, ]

Constants

AUTHOR_SCHEMA

public mixed AUTHOR_SCHEMA = ['name' => 'string', 'username' => 'string', 'website' => 'string']

BLOG_POST_SCHEMA

public mixed BLOG_POST_SCHEMA = ['title' => 'string', 'description' => 'string', 'category' => 'string', 'date' => 'string', 'author' => ['string', \Hyde\Markdown\Contracts\FrontMatter\SubSchemas\AuthorSchema::AUTHOR_SCHEMA], 'image' => ['string', \Hyde\Markdown\Contracts\FrontMatter\SubSchemas\FeaturedImageSchema::FEATURED_IMAGE_SCHEMA]]

PAGE_SCHEMA

public mixed PAGE_SCHEMA = [ 'title' => 'string', 'description' => 'string', // For <meta name='description'> values. It is used by the automatic page metadata generator, which reads this value from the front matter. 'canonicalUrl' => 'string', // While not present in the page data as a property, it is used by the accessor method, which reads this value from the front matter. 'navigation' => \Hyde\Markdown\Contracts\FrontMatter\SubSchemas\NavigationSchema::NAVIGATION_SCHEMA, ]

        
On this page

Search results