NAME
Markdown::Foswiki - Convert Markdown to Foswiki(Twiki) α
VERSION
version 0.04
SYNOPSIS
use Markdown::Foswiki;
my $mc = Markdown::Foswiki->new();
my @md_lines = $mc->getData('index.md');
my $fw_text = $mc->process(@md_lines);;
print $fw_text;
use Markdown::Foswiki;
my $mc = Markdown::Foswiki->new();
print $mc->process($mc->getData('index.md'));
$mc->save ( $fw_text, '', 'index.txt');
DESCRIPTION
This module markdown format files foswiki (Twiki) to convert the format of the module.
markdown in the case of internal links basepath (directory) specified in the config, and remove all the extensions are removed and replaced with basepath.
If the external link is retained.
CODE detecting
This Feature wrapping to %CODE% Mark or verbatim tag if detect code context
you can switching Whether to use from config-IncLang Attribute
set 'none' if want to maintaining code context
set 'plain' if want to wrapping to verbatim tag
be Styling with in SyntaxHighlighter if setting other options,
must installed SyntaxHighLighter plugin at your foswiki or twiki
METHODS
new
create Markdown::Foswiki instance
getData( $MarkdownFile )
@ML = $mc->getData( $file );
Returns loaded markdown text lines from $file
process( @MarkdownLines )
$FwText = $mc->process( @ML );
setConfig( 'Arg1' => Value ,...)
header_text
default :
%META:TOPICINFO{author="Markdown::Foswiki" date="unixTimeStamp" format="1.1" version="1"}%
or your header
head_contents
default :
"%TOC%\n";
or your head contents
footer_text
default :
blink
or your footer
foot_contents
default :
blink
or your foot contents
InterLinkBase
default :
blink
IncLang
for code detectings
default :
plain
options none plain c c++ sql perl ...
save( $fwText, savedir, savefile)
$mc->save($FwText, '', 'newfile.txt');
SUPPORT
SEE ALSO
SOURCE REPOSITORY
https://github.com/skyend/Markdown--Foswiki
AUTHOR
J.W. Han (skyend) <skyend@cpan.org>
COPYRIGHT AND LICENSE
Copyright (c) J.W. Han, all rights reserved.
This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
1 POD Error
The following errors were encountered while parsing the POD:
- Around line 317:
Non-ASCII character seen before =encoding in 'α'. Assuming CP1252