majek 0.1.1 → 0.1.2

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    majek (0.1.1)
+    majek (0.1.2)
       md_inc
 
 GEM

data/README.md

@@ -1,13 +1,30 @@
 Majek
 =====
 
-Tool to convert Markdown to Jekyll post format
+Majek is a preprocessor for Jekyll/Octopress blog posts that helps you to
+concentrate on writing. It allows you to include other files from your Markdown
+(thanks to [md_inc]) and produce posts in Jekyll format.
+
+Majek is especially helpful when you're writing Markdown with a tool like
+[iA Writer] that is more about prose and less about code. Instead of including
+bulky code snippets directly in your Markdown file, you simply insert short
+commands like `.inc 'foo.txt'` or `.codeblock 'bar.rb'`, which will then be
+expanded by Majek.
 
 
 Installation
 ------------
 
-TODO
+You can install Majek via RubyGems:
+
+    $ gem install majek
+
+Alternatively, you can install the gem from source:
+
+    $ git clone git://github.com/mlafeldt/majek.git
+    $ cd majek/
+    $ bundle install
+    $ bundle exec rake install
 
 
 Usage
@@ -15,6 +32,94 @@ Usage
 
     usage: majek <markdown file>
 
+Simply pass Majek a Markdown file and it will do the following:
+
+- read the contents of the Markdown file
+- process the text with md_inc which provides commands to include other text
+  files (`.inc`) and code (`.code_inc`) and more
+- process the text using custom md_inc commands for Octopress, see below
+- add a Jekyll header with title, date, categories, etc. (will be configurable
+  in the future)
+- output the final text to screen
+
+In addition to the default commands of md_inc, Majek provides the following
+Octopress-specific commands:
+
+- `.blockquote path [,attributes...]`
+- `.codeblock path [,attributes...]`
+- `.pullquote path [,attributes...]`
+- `.gist [attributes...]`
+- `.img [attributes...]`
+- `.include_code [attributes...]`
+- `.jsfiddle [attributes...]`
+- `.render_partial [attributes...]`
+- `.video [attributes...]`
+
+Make sure to also read the documentation of [md_inc] to learn more.
+
+
+Examples
+--------
+
+Given a standard Markdown file like this:
+
+```
+$ cat month_of_coderwall_protips.md
+# One Month of Coderwall Protips
+
+On 1 January 2013, I signed up on [Coderwall](https://coderwall.com/) -- a place
+for developers to share tips and connect with one another. I've been ...
+```
+
+Majek will produce text that is ready to be fed into Jekyll:
+
+```
+$ majek one_month_of_coderwall_protips.md
+---
+layout: post
+title: "One Month of Coderwall Protips"
+date: 2013-02-14 11:01:09 +0100
+comments: true
+categories:
+---
+
+On 1 January 2013, I signed up on [Coderwall](https://coderwall.com/) -- a place
+for developers to share tips and connect with one another. I've been ...
+```
+
+The second example shows one of the Octopress commands in action:
+
+```
+By stubbing out Chef's `include_recipe` method before the converge, Chef will
+not include any recipes during the test run:
+
+.codeblock 'snippets/stub-spec.rb', 'lang:ruby'
+
+This requires a bit of symlink trickery to work though.
+```
+
+The result will include the Ruby code from the specified file (Jekyll stuff
+stripped for brevity):
+
+```
+By stubbing out Chef's `include_recipe` method before the converge, Chef will
+not include any recipes during the test run:
+
+{% codeblock lang:ruby %}
+require 'chefspec'
+
+describe 'The recipe foo::default' do
+  let (:chef_run) do
+    Chef::Recipe.any_instance.stub(:include_recipe)
+    ChefSpec::ChefRunner.new.converge 'foo::default'
+  end
+  # ...
+end
+{% endcodeblock %}
+
+This requires a bit of symlink trickery to work though.
+```
+
 
 License
 -------
@@ -31,3 +136,5 @@ Contact
 
 
 [LICENSE]: https://github.com/mlafeldt/majek/blob/master/LICENSE
+[iA Writer]: http://www.iawriter.com/
+[md_inc]: https://github.com/russolsen/md_inc

data/lib/majek/version.rb

@@ -1,3 +1,3 @@
 module Majek
-  VERSION = '0.1.1'
+  VERSION = '0.1.2'
 end

data/majek.gemspec

@@ -4,7 +4,7 @@ require File.expand_path('../lib/majek/version', __FILE__)
 Gem::Specification.new do |s|
   s.authors       = ['Mathias Lafeldt']
   s.email         = ['mathias.lafeldt@gmail.com']
-  s.description   = %q{Tool to convert Markdown to Jekyll post format}
+  s.description   = %q{A preprocessor for Jekyll/Octopress blog posts that helps you to concentrate on writing}
   s.summary       = s.description
   s.homepage      = 'http://mlafeldt.github.com/majek'
   s.license       = 'MIT'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: majek
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-13 00:00:00.000000000 Z
+date: 2013-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: md_inc
@@ -43,7 +43,8 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: Tool to convert Markdown to Jekyll post format
+description: A preprocessor for Jekyll/Octopress blog posts that helps you to concentrate
+  on writing
 email:
 - mathias.lafeldt@gmail.com
 executables:
@@ -78,7 +79,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2670310394678098680
+      hash: 204157305799219663
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -87,11 +88,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2670310394678098680
+      hash: 204157305799219663
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
-summary: Tool to convert Markdown to Jekyll post format
+summary: A preprocessor for Jekyll/Octopress blog posts that helps you to concentrate
+  on writing
 test_files: []