Name

Text::Markup::None - Turn a file with no known markup into HTML

Synopsis

  use Text::Markup;
  my $html = Text::Markup->new->parse(file => 'README');
  my $raw  = Text::Markup->new->parse(
      file    => 'README',
      options => [ raw => 1 ],
  );

Description

This is the default parser used by Text::Markdown in the event that it cannot determine the format of a text file. All it does is read the file in (relying on a BOM, encodes all entities, and then returns an HTML string with the file in a <pre> element. This will be handy for files that really are nothing but plain text, like README files.

By default this parser is not associated with any file extensions. To have Text::Markup also recognize files for this module, load it directly and pass a regular expression matching the desired extension(s), like so:

  use Text::Markup::None qr{te?xt};

Normally this module returns the output wrapped in a minimal HTML document skeleton. If you would like the raw output without the skeleton, you can pass the raw option to parse.

Author

David E. Wheeler <david@justatheory.com>

Copyright and License

Copyright (c) 2011-2024 David E. Wheeler. Some Rights Reserved.

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