1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292
|
#!/usr/bin/env perl
use strict;
use warnings;
use Carp;
use Cwd;
use Config::Tiny;
use Data::Dumper;
use English qw(-no_match_vars);
use File::Basename;
use Getopt::Long qw(:config no_ignore_case auto_abbrev);
use Readonly;
use Pod::Usage qw(pod2usage);
use Markdown::Render;
our $VERSION = $Markdown::Render::VERSION;
Readonly our $EMPTY => q{};
Readonly our $TRUE => 1;
Readonly our $FALSE => 0;
########################################################################
sub version {
########################################################################
my ($name) = File::Basename::fileparse( $PROGRAM_NAME, qr/[.][^.]+$/xsm );
print "$name $VERSION\n";
return;
}
########################################################################
sub get_git_user {
########################################################################
my ( $git_user, $git_email );
for ( ( getcwd . '.git/config' ), "$ENV{HOME}/.gitconfig" ) {
next if !-e $_;
my $config = eval { Config::Tiny->read($_); };
( $git_user, $git_email ) = @{ $config->{user} }{qw(name email)};
last if $git_user && $git_email;
}
return ( $git_user, $git_email );
}
# +------------------------ +
# | MAIN SCRIPT STARTS HERE |
# +------------------------ +
my %options;
my @options_spec = qw(
body|B!
both|b
css=s
debug
engine=s
help
infile=s
mode=s
no-title
nocss|N
outfile=s
raw|R
render|r
title=s
version
);
GetOptions( \%options, @options_spec )
or croak 'could not parse options';
$options{body} //= $TRUE;
if ( $options{raw} ) {
$options{body} = $FALSE;
}
if ( exists $options{help} ) {
pod2usage(0);
}
if ( exists $options{version} ) {
version;
exit 0;
}
$options{no_title} = delete $options{'no-title'};
my $markdown;
if ( !$options{infile} ) {
if (@ARGV) {
$options{infile} = shift @ARGV;
}
elsif ( !-t STDIN ) { ## no critic (ProhibitInteractiveTest)
local $RS = undef;
my $fh = *STDIN;
$markdown = <$fh>;
}
}
my ( $git_user, $git_email ) = get_git_user();
$options{git_user} = $git_user // $EMPTY;
$options{git_email} = $git_email // $EMPTY;
my $md = Markdown::Render->new( %options, markdown => $markdown );
my $ofh = *STDOUT;
if ( exists $options{outfile} ) {
open $ofh, '>', $options{outfile} ## no critic (RequireBriefOpen)
or croak "could not open output file\n";
}
eval {
if ( $options{both} ) {
$md->finalize_markdown->render_markdown;
$md->print_html( %options, fh => $ofh );
}
elsif ( $options{render} ) {
$md->render_markdown;
$md->print_html( %options, fh => $ofh );
}
else {
$md->finalize_markdown;
print {$ofh} $md->get_markdown;
}
};
croak "ERROR: $EVAL_ERROR"
if $EVAL_ERROR;
close $ofh;
exit 0;
__END__
=head1 NAME
md-utils - Render markdown as HTML
=head1 SYNOPSIS
md-utils [options] [markdown-file]
=head1 DESCRIPTION
Utility to add a table of contents and other goodies to your GitHub
flavored markdown.
=over
=item *
Add C<@TOC@> where you want to see your TOC.
=item *
Add C<@TOC_BACK@> to insert an internal link to TOC.
=item *
Add C<@DATE(I<format-str>)@> where you want to see a formatted date.
=item *
Add C<@GIT_USER@> where you want to see your git user name.
=item *
Add C<@GIT_EMAIL@> where you want to see your git email address.
=item *
Use the --render option to render the HTML for the markdown
=back
=head1 EXAMPLES
md-utils README.md.in > README.md
md-utils -r README.md.in
=head1 OPTIONS
=over
=item B<-B>, B<--body>
Default is to add body tag, use --nobody to prevent.
=item B<-b>, B<--both>
Interpolates intermediate file and renders HTML.
=item B<-c>, B<--css>
CSS file.
=item B<-e>, B<--engine>
Engine to use, options: github, text_markdown (default: text_markdown).
=item B<-h>, B<--help>
Help.
=item B<-i>, B<--infile>
Input file, default: STDIN
=item B<-m>, B<--mode>
For GitHub API mode is 'gfm' or 'markdown' (default: markdown).
=item B<-N>, B<--nocss>
Do not add any CSS link
=item B<-n>, B<--no-title>
Do not print a title for the table of contents.
=item B<-o>, B<--outfile>
Output file, default: STDOUT.
=item B<-r>, B<--render>
Render only, does NOT interpolate keywords.
=item B<-R>, B<--raw>
Return raw HTML from engine.
=item B<-t>, B<--title>
String to use for a custom title, default: "Table of Contents".
=item B<-v>, B<--version>
Version.
=back
=head1 TIPS
=over
=item *
Use C<!#> to prevent a header from being include in the table of contents. Add
your own custom back to TOC message C<@TOC_BACK(Back to Index)@>.
=item *
Date format strings are based on format strings supported by the Perl module
L<Date::Format>. The default format is C<%Y-%m-%d> if no format is given.
=item *
Use the --nobody tag to return the HTML without the
C<< <html><body></body></html> >> wrapper. --raw mode will also return HTML
without wrapper.
=back
=head1 SEE ALSO
L<Markdown::Render>
=head1 AUTHOR AND LICENSE
Rob Lauer - rlauer6@comcast.net
This program is free software; you can use it and/or distribute it under the
same terms as Perl itself.
=cut
|