DOKK / manpages / debian 11 / libcode-tidyall-plugin-yamlfrontmatter-perl / Code::TidyAll::Plugin::YAMLFrontMatter.3pm.en
Code::TidyAll::Plugin::YAMLFrontMatter(3pm) User Contributed Perl Documentation Code::TidyAll::Plugin::YAMLFrontMatter(3pm)

Code::TidyAll::Plugin::YAMLFrontMatter - TidyAll plugin for validating YAML Front Matter

version 1.000003

In your .tidyallrc file:

    [YAMLFrontMatter]
    select = **/*.md
    required_top_level_keys = title layout

This is a validator plugin for Code::TidyAll that can be used to check that files have valid YAML Front Matter, like Jekyll et al use.

It will complain if:

"required_top_level_keys"
Keys that must be present at the top level of the YAML Front Matter.
"encoding"
The encoding the file is in. Defaults to UTF-8 (just like Jekyll 2.0 and later.)

Jekyll's Front Matter Documentation <https://jekyllrb.com/docs/frontmatter/>

Please report all issues with this code using the GitHub issue tracker at <https://github.com/maxmind/Code-TidyAll-Plugin-YAMLFrontMatter/issues>.

Bugs may be submitted through <https://github.com/maxmind/Code-Tidyall-Plugin-YAMLFrontMatter/issues>.

Mark Fowler <mfowler@maxmind.com>

  • Dave Rolsky <autarch@urth.org>
  • Greg Oschwald <goschwald@maxmind.com>

This software is copyright (c) 2019 by MaxMind, Inc.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

2020-01-23 perl v5.30.0