mdpress 0.0.14 → 0.0.15

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Aditya Bhargava
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,156 @@
+# mdpress
+
+This is a tool that converts markdown files to presentations using impress.
+
+# Example
+
+[This presentation](http://egonschiele.github.com/mdpress/default) was created from [this markdown file](https://raw.github.com/egonSchiele/mdpress/master/examples/demo.md).
+
+[This presentation](http://egonschiele.github.com/mdpress/impress) was created from the same markdown file and a different stylesheet using `mdpress -s [stylesheet name]`.
+
+
+## Advantages
+
+- dead simple, works with any markdown file
+- comes with a beautiful default stylesheet + more styles (more styles TBD) ... no need to write your own
+- ...but you can write your own easily if you want!
+- comes with [prettify](http://code.google.com/p/google-code-prettify/) integrated, does code highlighting out of the box
+- has an auto-update mode; update your markdown file and mdpress will update your presentation automatically
+- quick install as a ruby gem
+- presentations are tiny and easy to distribute
+- presentations are easy to read as a plain text file
+
+## Install
+
+	gem install mdpress
+
+## Usage
+
+	mdpress [filename.md]
+  mdpress [http://www.yourdomain.com/path/to/filename.md]
+
+This creates a directory named `filename`. Start the presentation by opening up `index.html`.
+
+## Quickstart (writing your first presentation!)
+
+	# Chicken Chicken Chicken
+	## By Chicken
+
+	---
+
+	# Chicken
+	- Chicken
+	- Chicken Chicken
+
+Save that as `test.md` and then use `mdpress test.md` to convert it to a presentation.
+`mdpress` uses [Redcarpet](https://github.com/tanoku/redcarpet), so it can parse whatever markdown you throw at it.
+We use the horizonal rule, `---`, to indicate the start of a new slide.
+
+### Getting Fancy: adding transformations
+
+So far the slide transitions haven't been that exciting. Let's spice them up.
+Below the `---`, type:
+
+	= data-x="1000"
+
+And re-compile with `mdpress test.md` (you might have to delete your old presentation directory first).
+
+Aha! Not bad! We specify transformations with `= [list of transformations]` as the first line of whatever slide we want to apply the transformation to.
+
+We could have written
+
+	= data-x="1000" data-scale="2"
+
+To make it scale as well as swipe.
+
+## Possible Attributes
+
+- `data-x`, `data-y`, `data-z`: positioning
+- `data-rotate-x`, `data-rotate-y`, 'data-rotate-z`, `data-rotate`: rotation (`data-rotate` and `data-rotate-z` are exactly the same)
+- `data-scale`: scale
+- `id`: used as the slide link. For example, if you use `id=intro`, you can link to that slide using `index.html#/intro`.
+
+See [impress.js](https://github.com/bartaz/impress.js/blob/master/index.html) for a broader description of these.
+
+Adding this syntax to Markdown feels like kind of a hack, but it's concise. I'm open to suggestions for something better.
+
+## Auto-update
+
+Earlier, our workflow involved having to delete the old presentation and recompile every time we made an edit. The better choice is to use the automatic mode:
+
+	mdpress -a [filename.md]
+
+Now, `mdpress` will keep running and check for updates to your markdown file. It will automatically recompile the presentation for you, so you can seamlessly edit your markdown and view your changes instantly.
+
+## Stylesheets
+
+`mdpress` comes with a default stylesheet, plus a few more. See the full list of available stylesheets with
+
+	mdpress -l
+
+Or specify a stylesheet to use with
+
+	mdpress -s [stylesheet]
+
+If you make your own stylesheets, send me a pull request and I'll add them to the list! See below.
+
+You can also create your own local theme:
+
+1. Use the 'lib/impress_css/' files as a model to work from.
+2. Create a folder called 'themes' in the directory where your markdown
+   file is. Inside it put the [yourtheme].css and [yourtheme].html files
+3. Call mdpress -s [yourtheme] and mdpress will look for the two theme
+   files in themes/ matching that name.
+
+## Running a presentation
+
+Someone emailed you a `mdpress` presentation. Now you want to **just run it**? Sure:
+
+	mdpress -r [filename.md]
+
+That will automatically compile the presentation and open it in a browser window.
+
+## Latex Support
+
+mdpress now has Latex support through [MathJax](http://www.mathjax.org/). To build your presentation with latex support, use the `--latex` flag.
+
+Put your latex code between a pair of `$$`'s, like this:
+
+    # Latex!
+    $$e^{\imath\pi} = -1$$
+
+**Note**: you might run into conflicts between markdown and latex. For example, `_` means emphasize in markdown. So if you want subscripts, escape `_`:
+
+    $a_x$ # wrong, x will be italic
+    $a\_x$ # right, x will be a subscript
+
+## Metadata
+
+Metadata can be set via YAML-Frontmatter. Have a look at the examples for further information. For example, if you want to set a title, put this at the top of the markdown file:
+
+    ---
+    title: All about chicken
+    ---
+  
+
+## Contributing
+
+To contribute a new stylesheet, follow these steps:
+
+1. Fork this repo.
+2. Place your new stylesheet in `lib/impress_css/[your stylesheet name].css`
+3. Send me a pull request!
+
+## Contributors
+
+- Mte90
+
+## License (MIT)
+
+Copyright (C) 2012 by Aditya Bhargava
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/bin/mdpress

@@ -6,6 +6,7 @@ require 'impress_renderer'
 require 'trollop'
 require 'tempfile'
 require 'launchy'
+require 'yaml'
 
 THEMES_DIRNAME = './themes/'
 
@@ -43,15 +44,23 @@ def readfile file
   end
 end
 
+def extract_metadata text
+  if md = text.match(/\A(---\s*\n.*?\n?)^(---\s*$\n?)/m)
+    [md.post_match, YAML.load(md[1])]
+  else
+    [text, {}]
+  end
+end
+
 def render opts
-  text = readfile(FILENAME)
+  text, metadata = extract_metadata(readfile(FILENAME))
   # ugly hack to get attributes for impress.js
   # TODO make this pretty
   lines = text.split("\n")
   lines.drop_while { |l| l =~ /^\s*$/ }
 
   attrs = [""]
-  
+
   new_lines = []
   lines.each_with_index do |line, i|
     if line =~ /^=(.*)$/ && (i == 0 || lines[i-1] =~ /^(-\s*){3,}$/)
@@ -69,10 +78,10 @@ def render opts
   # now use those attributes and render the file
   include Redcarpet
   ImpressRenderer.init_with_attrs attrs, opts
+  ImpressRenderer.author= metadata['author'] if metadata['author']
+  ImpressRenderer.title= metadata['title'] if metadata['title']
   if File.exist?(STYLESHEET_HEAD)
-    ImpressRenderer.set_head(File.read(STYLESHEET_HEAD))
-  else
-    ImpressRenderer.set_head("")
+    ImpressRenderer.head= File.read(STYLESHEET_HEAD)
   end
 
   m = Markdown.new(ImpressRenderer, :autolink => true, :fenced_code_blocks => true, :tables => true)
@@ -117,7 +126,7 @@ end
 if File.exist?(THEMES_DIRNAME + "#{OPTS[:stylesheet]}.css")
     STYLESHEET = THEMES_DIRNAME + "#{OPTS[:stylesheet]}.css"
     STYLESHEET_HEAD = THEMES_DIRNAME + "#{OPTS[:stylesheet]}.html"
-else 
+else
     STYLESHEET = base_dir + "impress_css/#{OPTS[:stylesheet]}.css"
     STYLESHEET_HEAD = base_dir + "impress_css/#{OPTS[:stylesheet]}.html"
 end

data/examples/code.md

@@ -0,0 +1,6 @@
+# Here's some code!
+
+    def fib x
+      return x if x < 2
+      fib(x - 1) + fib(x - 2)
+    end

data/examples/demo.md

@@ -0,0 +1,24 @@
+---
+author: Aditya Bhargava
+title: All about chicken
+---
+# Just because
+## my middle name
+
+is **Pancake**,
+
+> doesn't mean you can put syrup on me before I'm ready to come out of the oven.
+
+	mdpress++
+
+---
+= data-x='1000'
+# Let's Make Lists!
+
+1. Chicken
+2. *Emphasized Chicken*
+3. [Chicken Link](http://github.com/egonschiele/mdpress)
+
+- unordered `chicken = 1`
+
+

data/examples/helloworld.md

@@ -0,0 +1,7 @@
+# Hello
+## World!
+
+---
+= data-x='1000'
+
+# Hi, mdpress!

data/lib/impress_renderer.rb

@@ -2,7 +2,7 @@ require 'redcarpet'
 class ImpressRenderer < Redcarpet::Render::HTML
   @@attrs = []
   @@current = 0
-  @@head = ""
+  @@author, @@head, @@title = nil
 
   def self.init_with_attrs _attrs, _opts
     @@attrs = _attrs
@@ -10,10 +10,18 @@ class ImpressRenderer < Redcarpet::Render::HTML
     @@opts = _opts
   end
 
-  def self.set_head head
+  def self.author= author
+    @@author = "<meta name=\"author\" content=\"#{author}\">"
+  end
+
+  def self.head= head
     @@head = head
   end
 
+  def self.title= title
+    @@title = "<title>#{title}</title>"
+  end
+
   def hrule
     # this is how we later inject attributes into pages. what an awful hack.
     @@current += 1
@@ -47,7 +55,9 @@ class ImpressRenderer < Redcarpet::Render::HTML
     %{<!DOCTYPE html>
 <html>
   <head>
+    #{@@title}
     <link href="css/reset.css" rel="stylesheet" />
+    #{@@author}
     <meta charset="utf-8" />
     <meta name="viewport" content="width=1024" />
     <meta name="apple-mobile-web-app-capable" content="yes" />

metadata

@@ -1,87 +1,89 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: mdpress
-version: !ruby/object:Gem::Version
-  version: 0.0.14
+version: !ruby/object:Gem::Version 
+  hash: 1
   prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 15
+  version: 0.0.15
 platform: ruby
-authors:
+authors: 
 - Aditya Bhargava
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-29 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
+
+date: 2012-10-29 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
   name: redcarpet
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: trollop
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: trollop
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: launchy
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: launchy
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: httparty
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: httparty
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id004
 description: Build impress.js presentations from markdown files.
 email: bluemangroupie@gmail.com
-executables:
+executables: 
 - mdpress
 extensions: []
+
 extra_rdoc_files: []
-files:
+
+files: 
+- README.md
+- LICENSE
 - lib/css/apple-touch-icon.png
 - lib/css/favicon.png
 - lib/css/highlight.css
@@ -127,29 +129,41 @@ files:
 - lib/js/highlight.pack.js
 - lib/js/impress.js
 - bin/mdpress
-- bin/test.md
+- examples/code.md
+- examples/demo.md
+- examples/helloworld.md
 homepage: https://github.com/egonSchiele/mdpress
 licenses: []
+
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
+required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
 requirements: []
+
 rubyforge_project: 
 rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: Build impress.js presentations from markdown files.
 test_files: []
+

data/bin/test.md

@@ -1,2 +0,0 @@
-# Hello
-World!