---
name: "Text::Markup::Creole"
section: "3pm"
platform: "linux"
package: "libtext-markup-perl"
version: "0.33-1"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/Text::Markup::Creole"
---

# Text::Markup::Creole(3pm)

Creole parser for Text::Markup

## Name

Text::Markup::Creole - Creole parser for Text::Markup

## Synopsis

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

## Description

This is the Creole \<https://www.wikicreole.org/\> parser for Text::Markup. It reads in the file (relying on a BOM \<https://www.unicode.org/unicode/faq/utf\_bom.html#BOM\>), hands it off to Text::Markdown for parsing, and then returns the generated HTML as an encoded UTF-8 string with an `"http-equiv="Content-Type""` element identifying the encoding as UTF-8.

It recognizes files with the following extensions as Markdown:

- *.creole*

  To change it the files it recognizes, load this module directly and pass a regular expression matching the desired extension(s), like so:

```
  use Text::Markup::Creole qr{cre+ole+};
```

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

Lucas Kanashiro \<kanashiro.duarte@gmail.com\>

## Copyright and License

Copyright (c) 2011-2023 Lucas Kanashiro. Some Rights Reserved.

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