NAME

    App::sdview - a terminal document viewer for Pod and other syntaxes

SYNOPSIS

       use App::sdview;
    
       exit App::sdview->new->run( "some-file.pod" );

DESCRIPTION

    This module implements a terminal-based program for viewing structured
    documents. It currently understands Pod, some simple Markdown
    formatting, and a basic understanding of nroff (for manpages). Future
    versions may expand on these abilities, extending them or adding new
    formats.

    To actually use it, you likely wanted wanted to see the bin/sdview
    script.

       $ sdview Some::Module
    
       $ sdview lib/Some/Module.pm
    
       $ sdview README.md
    
       $ sdview man/somelib.3

    Various output plugins exist. By default it will output a
    terminal-formatted rendering of the document via the less pager, but it
    can also output plaintext, Pod, Markdown.

       $ sdview Some::Module -o plain > module.txt
    
       $ sdview Some::Module -o Markdown > module.md

TODO

      * Add more formats. ReST perhaps. Maybe others too.

      * Improved Markdown parser. Currently the parser is very simple.

      * Other outputs. Consider a Tickit-based frontend.

      Also more structured file writers - ReST.

AUTHOR

    Paul Evans <leonerd@leonerd.org.uk>