quivjek 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d65ca409aa9ca6a4c89f989eec03ccd3e66a1e9c
-  data.tar.gz: 469b356a3621fa41b28bd33cb7ed135288b12c0e
+  metadata.gz: 89f2083f8fa0d38194df93c7d644cfedbe29cb6e
+  data.tar.gz: 3d986b97b490e32f475c79843ca871b065b202be
 SHA512:
-  metadata.gz: dc8ab9c141826190767d34878e239e91eb1d6fb66e3ac55f2ce85853918e100408c5096fc3939075e74794fb90c27963acc67dc0b4924f34a67c2c92fc9c03e9
-  data.tar.gz: f386bf52dd19ef84284c5d6be28733757d48b0be4238413c34156e81a79e2833f6a21c480ac5131c8794862d0c3d69db58e3e3cc15a43798a80667afcadf24a8
+  metadata.gz: e2ee61b8194aa8f511eed12d8df343287efa1cd9f93ba67838923c4e55b3c1ce227b7d16b9206d3e909687ed9208371e6c859b0bee49bf091f3e74c9c8388351
+  data.tar.gz: 596e4f64b2b3ef9a121732fa76af0b68e183ddaeae1993ea24d4a47d985228c5bc6509ad9770dd92857e9d8c060b6d723ffc71f44aec34f4c6c21188ccdd1929

data/README.md

@@ -1,52 +1,47 @@
-#Quivjek: A Jekyll plugin for seamless publication of Quiver notebooks
+# Quivjek: A Jekyll plugin for seamless publication of Quiver notebooks
 [![Build Status](https://travis-ci.org/benbjurstrom/quivjek.svg?branch=master)](https://travis-ci.org/benbjurstrom/quivjek)
 
-Quivjek is a Jekyll plugin that automatically copies a specified Quiver notebook to your Jekyll _posts folder whenever the jekyll build command runs. Quivjek also copies and properly links any images contained in a Quiver note to your Jekyll images folder.
+Quivjek is a Jekyll plugin that automatically exports all notes from a specified Quiver notebook to your _posts folder when the jekyll build command is run. Quivjek also copies and properly links any images contained in a Quiver note to your Jekyll images folder.
 
 ## Installation
 1. Install the quivjek gem
 ```
 gem install quivjek
 ```
-2. In jekyll's \_config.yml file add quivjek to the gems array
+2. Add quivjek to the gems array found in the _config.yml file.
 ```
+#jekyll_dir/_config.yml
 gems: [quivjek]
 ```
-3. Point quivjek to the Quiver notebook of choice by adding the `notebook_dir:` key in jekyll's \_config.yml file and set the value equal to the path to your chosen Quiver notebook. For example:
+3. Point quivjek to the Quiver notebook of choice by adding the `notebook_dir:` key to the \_config.yml file with a value equal to your notebooks file path. For example:
 ```
-#jekyll _config.yml
+#jekyll_dir/_config.yml
 notebook_dir:~/Dropbox/Quiver/Quiver.qvlibrary/14F2BCE0-1B08-4ED6-993A-17C8AB0316E2.qvnotebook
 ```
 
-## Usage
-Simply run ```jekyll build``` and quivjek will automatically add your Quiver notes to your jekyll site.
-
-## How to I find my quiver notebook?
-Your Quiver notebook is contained within your Quiver library. Your Quiver library is a folder that ends with the extension .qvlibrary. You can find the location of your Quiver library in Quiver's menu by going under Quiver -> Preferences -> Sync and checking the Library Location. If using the command line you can cd into it like normal. If using finder, right click on the .qvlibrary and click show package contents.
+To determine a notebook's filepath right click on the note in the Quiver sidebar and choose open in finder. Be aware that Quiver notebooks are folders ending in the .qvnotebook extension and named with a random UUID as in the example above.
 
-Now that you're inside your Quiver libary folder you should see all of that libary's notebooks. Quiver notebooks are folders that end with the .qvnotebook extension. They will be named with a UUID as indiacted above. To determine the Quiver notebook's name check the meta.json file contained within each .qvnotebook folder.
+## Usage
+Simply run `jekyll build` and quivjek will automatically add your Quiver notes to your jekyll site
 
-## Other info
+## Things you should know
 All quiver notes must be entirely composed of markdown or code cells.
 
 Quivjek will ignore any posts tagged as `draft`
 
-Quivjek sets the post created date based on the Quiver created date. Currently there's no easy way to modify the Quiver create date short of modifying the timestamp in the note's meta.json file. Eventually I'd like to allow overriding this value through custom fronmatter.
+Quivjek sets the post created date based on the note's created date. Currently there's no easy way to modify the note's create date in Quiver short of modifying the timestamp in the note's meta.json file. Eventually I'd like to allow overriding this value through custom frontmatter.
 
-Quivjek currently copies all notes and images to the subfolders `/_posts/quiver` and `/images/q` respectivly. On build quivjek deletes all files from these subfolders and re-copies the notes and images from the Quiver notebook. This is done to clean up any deleted or renamed items. Eventually I'd like to save a manafest and only update the notes and images that have changed or been removed since the last build.
+Quivjek currently copies all notes and images to the jekyll directory within the subfolders `/_posts/quiver` and `/images/q` respectivly. On build quivjek deletes all files from these subfolders and re-copies the notes and images from the Quiver notebook. This is done to clean up any deleted or renamed items. Eventually I'd like to save a manafest and only update the notes and images that have been modified or deleted since the last build.
 
-## Development
+When an image is added to a markdown cell, Quiver renames the file and sets the original file name as the image tag's alt attribute. For example the image `big-claw-puppy-on-wood-floor.jpg` becomes `![big-claw-puppy-on-wood-floor.jpg](quiver-image-url/642370E09A291BC1601CFD68B44A5C16.jpg)`. For SEO purposes quivjek reverses this process by renaming the image to whatever is found in your alt tag. Therefore it is recormended your alt tags are lowercase, slug-ified, unique, and end in the image file extension.
 
+## Development
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/benbjurstrom/quivjek. This is my first time using ruby so pull requests to improve code style are welcome. Thanks to Bradley Curran's [quiver2jekyll](https://github.com/bradley-curran/quiver2jekyll/) package for pointing me in the right direction.
-
-
+This is my first time using Ruby so bug reports and pull requests are very welcome on GitHub at https://github.com/benbjurstrom/quivjek. Thanks to Bradley Curran's [quiver2jekyll](https://github.com/bradley-curran/quiver2jekyll/) for providing some of the code needed to get started.
 
 ## License
-
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/lib/quivjek/version.rb

@@ -1,3 +1,3 @@
 class Quivjek
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/quivjek.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
 
   spec.summary       = "A Jekyll plugin for seamless publication of Quiver notebooks"
   spec.description   = "A Jekyll plugin that automatically copies a Quiver notebook to your Jekyll _posts folder whenever the jekyll build command runs. Quivjek also copies and properly links any images contained in a Quiver note to your Jekyll images folder."
-  spec.homepage      = "https://github.com/benbjurstrom/keyburner"
+  spec.homepage      = "https://github.com/benbjurstrom/quivjek"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: quivjek
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Ben Bjurstrom
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-09-14 00:00:00.000000000 Z
+date: 2016-09-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -86,7 +86,7 @@ files:
 - lib/quivjek.rb
 - lib/quivjek/version.rb
 - quivjek.gemspec
-homepage: https://github.com/benbjurstrom/keyburner
+homepage: https://github.com/benbjurstrom/quivjek
 licenses:
 - MIT
 metadata: {}