Skip to content
No description, website, or topics provided.
Perl 6
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
lib/Text
t
.gitignore
.travis.yml
CONTRIBUTING.md
LICENSE
META6.json
README.md

README.md

Name

Text::Markdown, a Markdown parsing module for Perl6.

Build Status

Synopsis

use Text::Markdown;
# Using raw Markdown directly
my $md = Text::Markdown.new($raw-md);
say $md.render;

# Or alternatively
my $md = parse-markdown($raw-md);
say $md.to_html;

# Using file
use Text::Markdown;
my $md = parse-markdown-from-file($filename);

Description

This module parses Markdown (MD) and generates HTML from it. It can be used to extract certain elements from a MD document or to generate other kind of things.

Installation

Using zef

zef update && zef install Text::Markdown

Dependencies

This modules depends on HTML::Escape. Install it locally with

zef install HTML::Escape

Routines

Methods

The following methods can be invoked on a Text::Markdown instance object:

  • render - Render the Markdown text provided to the instance object during its construction.

  • to_html - An alias for the render method.

  • to-html - Same as the to_html method.

Subroutines

  • parse-markdown($text) - Render the Markdown $text.

  • parse-markdown-from-file(Str $filename) - Render the Markdown text in file $filename.

Who

Initial version by Andrew Egeler, with extensive additions by JMERELO and Altai-man.

Want to lend a hand?

Check out the contributing guidelines. All contributions are welcome, and will be addressed.

License

You can redistribute this module and/or modify it under the terms of the MIT License.

You can’t perform that action at this time.