octopress-printable
An octopress ink plugin generating printable version of markdown posts.
Prerequisites
- Pandoc, >= 1.13.2
- TeX Live 2013
Installation
Add this line to your application's Gemfile:
gem 'octopress-printable'
And then execute:
$ bundle
Or install it yourself as:
$ gem install octopress-printable
Usage
Add {% include octopress-printable:printable.html %}
to your site's layout, this will create a link to the pdf files corresponding current post or page.
Tags will be converted includes img
(from octopress-image-tag), gist
(from octopress-gist), bibliography
and cite
(from jekyll-scholar).
Details please refer to test/test-site/_posts/2015-04-29-foo.markdown
.
Configuration
To configure this plugin, run $ octopress ink copy octopress-printable --config
, then the config should be in _plugins/octopress-printable/config.yml
and add your settings. Here are
the defaults.
posts_dir: "_posts"
printables_dir: "assets/printables"
source_dir: "."
blog_url: "http://example.com" # used in pdf post_links
bibliography_dir: "_bibliography"
bibliography: "references.bib"
# only convert markdowns, without running pandoc and xelatex
dry_run : false
# debug files
dump_tex_file: false
dump_markdown_file: false
dump_bib_file: false
dump_cmds: false
keep_tmp_files: false
Contributing
- Fork it ( https://github.com/wantee/octopress-printable/fork )
- Create your feature branch (
git checkout -b my-new-feature
) - Commit your changes (
git commit -am 'Add some feature'
) - Push to the branch (
git push origin my-new-feature
) - Create a new Pull Request