.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Code::TidyAll::Plugin::YAMLFrontMatter 3pm"
.TH Code::TidyAll::Plugin::YAMLFrontMatter 3pm "2022-10-14" "perl v5.34.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Code::TidyAll::Plugin::YAMLFrontMatter \- TidyAll plugin for validating YAML Front Matter
.SH "VERSION"
.IX Header "VERSION"
version 1.000003
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
In your .tidyallrc file:
.PP
.Vb 3
\&    [YAMLFrontMatter]
\&    select = **/*.md
\&    required_top_level_keys = title layout
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This is a validator plugin for Code::TidyAll that can be used to check
that files have valid \s-1YAML\s0 Front Matter, like Jekyll et al use.
.PP
It will complain if:
.IP "There's no \s-1YAML\s0 Front Matter" 4
.IX Item "There's no YAML Front Matter"
.PD 0
.IP "The \s-1YAML\s0 Front Matter isn't valid \s-1YAML\s0" 4
.IX Item "The YAML Front Matter isn't valid YAML"
.IP "There's a \s-1UTF\-8 BOM\s0 at the start of the file" 4
.IX Item "There's a UTF-8 BOM at the start of the file"
.IP "The file isn't encoded in the configured encoding (\s-1UTF\-8\s0 by default)" 4
.IX Item "The file isn't encoded in the configured encoding (UTF-8 by default)"
.IP "The \s-1YAML\s0 Front Matter is missing one or more configured top level keys" 4
.IX Item "The YAML Front Matter is missing one or more configured top level keys"
.IP "The \s-1YAML\s0 Front Matter contains circular references" 4
.IX Item "The YAML Front Matter contains circular references"
.PD
.SS "Options"
.IX Subsection "Options"
.ie n .IP """required_top_level_keys""" 4
.el .IP "\f(CWrequired_top_level_keys\fR" 4
.IX Item "required_top_level_keys"
Keys that must be present at the top level of the \s-1YAML\s0 Front Matter.
.ie n .IP """encoding""" 4
.el .IP "\f(CWencoding\fR" 4
.IX Item "encoding"
The encoding the file is in.  Defaults to \s-1UTF\-8\s0 (just like Jekyll 2.0 and
later.)
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Jekyll's Front Matter Documentation <https://jekyllrb.com/docs/frontmatter/>
.SH "SUPPORT"
.IX Header "SUPPORT"
Please report all issues with this code using the GitHub issue tracker at
<https://github.com/maxmind/Code\-TidyAll\-Plugin\-YAMLFrontMatter/issues>.
.PP
Bugs may be submitted through <https://github.com/maxmind/Code\-Tidyall\-Plugin\-YAMLFrontMatter/issues>.
.SH "AUTHOR"
.IX Header "AUTHOR"
Mark Fowler <mfowler@maxmind.com>
.SH "CONTRIBUTORS"
.IX Header "CONTRIBUTORS"
.IP "\(bu" 4
Dave Rolsky <autarch@urth.org>
.IP "\(bu" 4
Greg Oschwald <goschwald@maxmind.com>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2019 by MaxMind, Inc.
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.