1Pod::Simple::Wiki::MarkUdsoewrn(C3o)ntributed Perl DocumPeondt:a:tSiiomnple::Wiki::Markdown(3)
2
3
4

NAME

6       Pod::Simple::Wiki::Markdown - A class for creating Pod to Markdown wiki
7       filters.
8

SYNOPSIS

10       This module isn't used directly. Instead it is called via
11       "Pod::Simple::Wiki":
12
13           #!/usr/bin/perl -w
14
15           use strict;
16           use Pod::Simple::Wiki;
17
18
19           my $parser = Pod::Simple::Wiki->new('markdown');
20
21           ...
22
23       Convert Pod to a markdown wiki format using the installed "pod2wiki"
24       utility:
25
26           pod2wiki --style markdown file.pod > file.wiki
27

DESCRIPTION

29       The "Pod::Simple::Wiki::Markdown" module is used for converting Pod
30       text to Markdown text.
31
32       Pod (Plain Old Documentation) is a simple markup language used for
33       writing Perl documentation.
34
35       This module isn't generally invoked directly. Instead it is called via
36       "Pod::Simple::Wiki". See the Pod::Simple::Wiki and pod2wiki
37       documentation for more information.
38

METHODS

40       Pod::Simple::Wiki::Markdown inherits all of the methods of
41       "Pod::Simple" and "Pod::Simple::Wiki". See Pod::Simple and
42       Pod::Simple::Wiki for more details.
43

Markdown Specific information

45       Some format features of Pod are not present in base Markdown (and vice-
46       versa).  In particular this module supports both code blocks and
47       definition lists - in a somewhat inconsistent fashion.  Code blocks are
48       supported using GitHub Markdown syntax: three backticks at the start
49       and end of the codeblock.  Definition lists are (crudely) supported in
50       the PHP Markdown Extra syntax: A colon followed by three spaces
51       starting the line with the definition.  PHP Markdown Extra works with
52       the GitHub syntax, so this should not cause a problem.  (GitHub does
53       not support definition lists.)  This module also creates nested
54       definition lists - which may or may not be supported.  (And may need
55       extra newlines entered, which is beyond the technical limits of this
56       module.)
57
58       Links are always output in the universal [link text](link source)
59       format, even when it's redundant, or overlong.  Anything POD considers
60       a link will be treated as one, even if it's not a valid link.  (In
61       particular, automatic 'man page' links will not point to anything
62       useful - the user will be required to turn "(Pod::Simple)" into
63       something useful, likely your favorite interface for CPAN.)
64
65       Escapes are automatically applied to asterisks, underscores, backticks,
66       and backslashes, and they are always required.  Markdown provides
67       escapes for other characters (in particular braces and parenthesis),
68       but they are not required in all cases.  I leave it up to the user to
69       determine when they would be considered formatting and when they
70       wouldn't.
71

SEE ALSO

73       This module also installs a "pod2wiki" command line utility. See
74       "pod2wiki --help" for details.
75

ACKNOWLEDGEMENTS

77       Thanks to Daniel T. Staal for patches, documentation or bugfixes.
78

DISCLAIMER OF WARRANTY

80       Please refer to the DISCLAIMER OF WARRANTY in Pod::Simple::Wiki.
81

AUTHORS

83       John McNamara jmcnamara@cpan.org
84
85       Daniel T. Staal DStaal@usa.net
86

88       MMIII-MMXV, John McNamara, Daniel T. Staal
89
90       All Rights Reserved. This module is free software. It may be used,
91       redistributed and/or modified under the same terms as Perl itself.
92
93
94
95perl v5.32.1                      2021-01-27    Pod::Simple::Wiki::Markdown(3)
Impressum