David E. Wheeler > SVN-Notify-Filter-Markdown > SVN::Notify::Filter::Markdown

Download:
SVN-Notify-Filter-Markdown-0.05.tar.gz

Dependencies

Annotate this POD

Website

View/Report Bugs
Module Version: 0.05   Source  

Name ^

SVN::Notify::Filter::Markdown - Convert SVN::Notify log messages from Markdown to HTML

Synopsis ^

Use svnnotify in post-commit:

  svnnotify --p "$1" --r "$2" --to you@example.com --handler HTML \
  --filter Markdown

Use the class in a custom script:

  use SVN::Notify;

  my $notifier = SVN::Notify->new(
      repos_path => $path,
      revision   => $rev,
      to         => 'you@example.com',
      handler    => 'HTML::ColorDiff',
      filters    => [ 'Markdown' ],
  );
  $notifier->prepare;
  $notifier->execute;

Description ^

This module filters SVN::Notify log message output to convert it from Markdown format to HTML. Essentially, this means that if you write your commit log messages in Markdown format and like to use SVN::Notify::HTML or SVN::Notify::HTML::ColorDiff to format your commit notifications, you can use this filter to convert the Markdown formatting in the log message to HTML. Just pass --filter Markdown to your call to svnnotify in post-commit and you're good to go.

If you don't know what any of this means, read the SVN::Notify documentation. It talks about using SVN::Notify to send nicely formatted emails for every Subversion commit. This module just makes them even more nicely formatted.

See Also ^

SVN::Notify
Text::Markdown
http://daringfireball.net/projects/markdown/

Support ^

This module is stored in an open GitHub repository. Feel free to fork and contribute!

Please file bug reports via GitHub Issues or by sending mail to bug-SVN-Notify-Filter-Markdown@rt.cpan.org.

Author ^

David E. Wheeler <david@justatheory.com>

Copyright and License ^

Copyright (c) 2008-2011 David E. Wheeler. Some Rights Reserved.

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

syntax highlighting: