https://github.com/leighmcculloch/spiffy
A simple to use markdown to HTML and PDF command line app. Supports Github flavored markdown and great for converting single or many documents into professional PDFs using ERB/HAML templates and CSS.
https://github.com/leighmcculloch/spiffy
Last synced: 4 months ago
JSON representation
A simple to use markdown to HTML and PDF command line app. Supports Github flavored markdown and great for converting single or many documents into professional PDFs using ERB/HAML templates and CSS.
- Host: GitHub
- URL: https://github.com/leighmcculloch/spiffy
- Owner: leighmcculloch
- License: bsd-2-clause
- Archived: true
- Created: 2015-03-06T16:22:09.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2016-08-22T20:33:36.000Z (almost 9 years ago)
- Last Synced: 2024-10-11T15:43:07.530Z (8 months ago)
- Language: CSS
- Homepage:
- Size: 530 KB
- Stars: 5
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# spiffy
A simple to use markdown to HTML and PDF command line app.
Supports Github flavored markdown and great for converting single or many documents into professional PDFs using ERB/HAML templates and CSS.
## Install
```bash
$ gem install spiffy
```
Or in your Gemfile:
```bash
gem 'spiffy'
```
## Use
```bash
$ spiffy
Usage: spiffy [options] [file] [file] ...
Options
-c, --css [css] CSS to include inline in the HTML file output
-t, --template [template] Template to wrap the resulting HTML
-p, --pdf [on|off] Output PDF files (default: off)
-m, --html [on|off] Output HTML files (default: on)
-o, --out [output directory] Output files to this directory
-h, --help This usage outline.
```
You can also specify options in a `.spiffy.yml` file. Running `spiffy` in a directory containing a spiffy YAML file will cause spiffy to run on all the files matched/specified by the YAML.
Example:
```yaml
# Markdown files starting with the word `Legal` use the legal
# template, and put the PDFs in the Output folder.
- markdown_files:
- Legal *.md
template_file: Legal.haml
html: false
pdf: true
output_dir: Output
# Markdown file Resume.md will use custom CSS, and put the PDF
# and HTML next to the input file.
- markdown_files:
- Resume.md
template_file: Resume.css
pdf: true
```