Git Product home page Git Product logo

octopress-printable's Introduction

octopress-printable

An octopress ink plugin generating printable version of markdown posts.

Build Status Gem Version License

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

  1. Fork it ( https://github.com/wantee/octopress-printable/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.