wool 0.1.3

Preview Github Markdown Offline
Documentation

wool

Wool is a modern, extensible grip clone that prefers offline-first rendering to strict Github API accuracy.

Installation

cargo install wool

Getting Started

Preview on localhost:

wool readme.md

Export to html:

wool readme.md --export mypreview.html
Experimental

Syntax highlighting using Prism:

wool readme.md -s

Equations with katex:

wool readme.md -k

Usage

USAGE:
    wool [FLAGS] <infile> [outfile]

FLAGS:
    -b, --browser             Open in browser
    -e, --export              Export html
    -h, --help                Prints help information
    -s, --highlight           Syntax highlighting
    -k, --katex               Include katex in rendering
    -n, --no-preview-frame    Don't render the preview frame
    -V, --version             Prints version information 
    
ARGS:
    <infile>     Sets the input file to use
    <outfile>    Sets the output file to use

Notes

To use the auto reload feature, must be in same directory as previewed file.