middleman-presentation 0.15.8 → 0.16.0.beta

data/Guardfile

@@ -1,13 +0,0 @@
-# encoding: utf-8
-# A sample Guardfile
-# More info at https://github.com/guard/guard#readme
-
-# Add files and commands to this file, like the example:
-#   watch(%r{file/path}) { `command(s)` }
-#
-guard :shell do
-  watch(%r{^source/slides/.+\.(?:erb|html)}) do
-    $stderr.puts 'Running middleman'
-    system('bundle exec middleman build')
-  end
-end

data/LICENSE.software

@@ -1,21 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2014 maxmeyer
-
-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

@@ -1,608 +0,0 @@
-# middleman-presentation
-
-[![Build Status](https://travis-ci.org/maxmeyer/middleman-presentation.png?branch=master)](https://travis-ci.org/maxmeyer/middleman-presentation)
-[![Coverage Status](https://coveralls.io/repos/maxmeyer/middleman-presentation/badge.png?branch=master)](https://coveralls.io/r/maxmeyer/middleman-presentation?branch=master)
-[![Gem Version](https://badge.fury.io/rb/middleman-presentation.svg)](http://badge.fury.io/rb/middleman-presentation)
-
-This project helps you to build wonderful presentations based on
-[HTML](http://www.w3.org/html/) and JavaScript. The JavaScript-part is powered
-by [`reveal.js`](https://github.com/hakimel/reveal.js), a great framework to
-build HTML-/JavaScript-presentations. The infrastructure behind
-`middleman-presentation` is powered by `middleman`, a flexible static site
-generator which also offers a live preview of your presentation.
-
-To get started with `middleman-presentation` you should know a little bit about
-HTML, JavaScript, reveal.js and [Ruby](https://www.ruby-lang.org/en).
-`middleman-presentation` will then help you wherever it can to make your life
-easy with presentations.
-
-Why you would like to use `middleman-presentation` instead of pure `reveal.js`?
-
-* It provides helper-commands for recurring tasks, e.g. create new
-  presentations, create new slides, editing slides
-* It separates data (slides) from style (theme) by using bower + sprockets
-* It supports a lot of template languages, e.g. Markdown, Erb, Liquid
-* It provides templates, but give you the freedom to define your own ones
-* It can be extended by using ruby
-
-## Installation
-
-### Gem
-
-Install via rubygems
-
-    gem install middleman-presentation
-
-Or add this line to your middleman application's Gemfile:
-
-    gem 'middleman-presentation'
-
-And then execute:
-
-    $ bundle
-
-### External Dependencies
-
-**Nodejs**
-
-Please install [`nodejs`](https://github.com/joyent/node). It is required by
-`bower` - see [bower](#bower_install)-section below. It is recommended to
-install it via [package
-manager](https://github.com/joyent/node/wiki/installing-node.js-via-package-manager).
-
-It is recommended to configure the path where global packages are installed.
-That ensures that you do not need to install global packages as `root`.
-
-1. Create `.npmrc`
-
-  ```bash
-  # Change <user> to your user
-  prefix = /home/<user>/.local/share/npm
-  
-  # If you need to use a coporate proxy, add those lines as well.
-  # Be careful `https-proxy` needs use a `http`-url, not a `https`-one
-  # proxy = http://localhost:3128
-  # https-proxy = http://localhost:3128
-  ```
-
-2. Make executables of nodejs-packages available via PATH
-
-   Add `npm`-bin dir to your PATH-variable via `.bashrc`, `.zshrc` or whatever
-   initialization-script your shell uses.
-
-    ```bash
-    export PATH=~/.local/share/npm/bin:$PATH
-    ```
-
-**Bower**
-<a name="bower_install"></a>
-
-You also need to install [`bower`](http://www.bower.io). It is used to install
-the assets (CSS-, JavaScript-files etc.).
-
-```bash
-npm install -g bower
-```
-
-**JavaScript Engine**
-
-Make sure you've got a javascript engine installed. Please follow the
-instructions found [here](https://github.com/sstephenson/execjs). I do not add
-this as a runtime-dependency to this gem. So it is your choice what engine you want to
-use.
-
-## Release Notes
-
-You find the release notes [here](RELEASE_NOTES.md) or on
-[github](https://github.com/maxmeyer/middleman-presentation/blob/master/RELEASE_NOTES.md).
-
-## Supported rubies
-
-* MRI >= 2.1.x
-
-## Find help
-
-* This [README.md](README.m)
-* A good [tutorial](http://htmlcheats.com/reveal-js/reveal-js-tutorial-reveal-js-for-beginners/) tutorial about `reveal.js`
-* The [documentation](https://github.com/hakimel/reveal.js/) of `reveal.js`
-* The [documentation](http://middlemanapp.com/) of `middleman`
-
-## Getting Started
-
-### Initialize middleman presentation globally
-
-To create a global configuration file for `middleman-presentation` you need to
-run the following command:
-
-```bash
-middleman-presentation init application
-```
-
-This will create a configuration file at
-`$HOME/.config/middleman/presentation/presentations.yaml`. The configuration options
-given there will be used for all presentations created with
-`middleman-presentation`. After running the command on a pristine system it
-will contain the defaults.
-
-Please run `cat $HOME/.config/middleman/presentation/presentations.yaml` to view them.
-
-### Initialize presentation
-
-This gem provides a helper to start a new presentatio from scratch. The given
-options below need to be given on command line.
-
-```bash
-# long
-middleman-presentation create presentation --title "my title" --speaker "Me"
-
-#short
-middleman-presentation create --title "my title" --speaker "Me"
-```
-
-The presentation helper provides a lot of more options. Use the help command to
-get an overview. If you want to switch the language for generated slides use
-the `--language`-switch.
-
-```bash
-bundle exec middleman help presentation
-```
-
-### Start your presentation
-
-To start your presentation use the `start`-script. It opens the presentation in
-your browser and starts `middleman`. After `middleman` has started you just
-need to reload the presentation in the browser.
-
-```bash
-# Short
-script/start
-
-# Long
-bundle exec middleman server
-```
-
-### Add new slide
-
-**MAKE SURE YOU NEVER EVER GIVE TWO SLIDES THE SAME BASENAME**, eg. 01.html.erb
-and 01.html.md. This will not work with `middleman`.
-
-To add a new slide you can use the `slide`-helper.
-
-```bash
-bundle exec middleman slide <name>
-```
-
-It is recommended to use a number as name greater than `00`, e.g. `01`. If you
-leave out the file extension the `slide`-helper will create a Markdown-slide by
-default. If you want to overwrite this, please create a custom-slide-template -
-see [Custom Templates](#custom_templates) for more information.
-
-```bash
-bundle exec middleman slide 01
-```
-
-If you enter duplicate slide names, e.g. "02.md" and "02.erb", the
-`slide`-command will fail. It is not possible to serve files with the same base
-name - e.g. "02" - via `middleman`.
-
-```bash
-bundle exec middleman slide 02.md 02.erb
-# => will fail
-```
-
-If you prefer another template language you can provide that information as
-part of the slide name. Today only `embedded ruby`, `markdown` and `liquid`-templates are supported.
-
-```bash
-# embedded ruby
-bundle exec middleman slide 01.erb
-
-# markdown
-bundle exec middleman slide 01.md
-bundle exec middleman slide 01.markdown
-
-# liquid
-bundle exec middleman slide 01.l
-bundle exec middleman slide 01.liquid
-```
-
-To set a title for the slide use the `--title`-switch.
-
-```bash
-bundle exec middleman slide 01 --title 'my Title'
-```
-
-If you want to create multiple slides at once, this is possible to. Just ask
-`middleman-presentation` to do this.
-
-```bash
-bundle exec middleman slide 01 02 03
-```
-
-There are some more options available. Please use the `help`-command to get an
-overview.
-
-```bash
-bundle exec middleman help slide
-```
-
-Both provide the possibility to change the port where middleman should listen
-on. Use `-h` check on available options.
-
-### Edit slide
-
-To edit the slide after creating it use the `--edit`-switch. It uses the
-`$EDITOR`-environment variable and falls back to `vim`.
-
-```bash
-bundle exec middleman slide 01 --edit
-```
-
-If you want to edit an alread created slide, you can use the
-`slide`-command as well. It creates slides if they do not exist and opens them
-in your favorit editor (ENV['EDITOR']) if they already exist.
-
-In some cases you might want to use a different editor-command. To change the
-editor used or the arguments used, you can run `middleman-presentation` with
-the `--editor-command`-switch.
-
-```bash
-bundle exec middleman slide --edit --editor-command "nano" 01 02 03
-```
-
-The `editor-command`-string is also parsed by Erubis which makes the data
-available in `metadata.yml` accessible to you. You can use this to start a vim server
-with the presentation's project id as server name. This can be handy if you work more
-or less simultaneously on diffent presentations. To make the use of the project
-id as server name more stable you should use [`Shellwords.shellescape`](http://www.ruby-doc.org/stdlib-2.1.2/libdoc/shellwords/rdoc/Shellwords.html#method-c-shellescape).
-
-```bash
-bundle exec middleman slide --edit --editor-command "vim --servername <%= Shellwords.shellescape(project_id) %> --remote-tab 2>/dev/null" 01 02 03
-```
-
-### Remove a slide
-
-If you remove a slide while `middleman` is showing the presentation, you might
-experience some weird errors. Please restart `middleman` after you removed a
-slide and everything will be fine again.
-
-### Export presentation
-
-If you need to export the presentation, you can use the `export`-script. It
-creates tar-file in `<root>/pkg/<presentation_directory_name>.tar.gz`.
-
-```bash
-script/export
-# => Creates tar-file in <root>/pkg/<presentation_directory_name>.tar.gz
-```
-
-## Reuse existing presentation
-
-*Bootstrap*
-
-Bootstrap the presentation environment.
-
-```bash
-script/bootstrap
-# => Installs all needed software components
-```
-
-*Start presentation*
-
-To start your presentation use the `start`-script.
-
-```bash
-script/start
-```
-
-### Ignore slides
-
-*Introduction*
-
-Sometimes you may want to slides to be available in the filesystem, but not
-part of your presentation. To make this possible you can use the
-`.slidesignore`-file. If you prefer a different name, change the
-configuration-option `:slides_ignore_file`.
-
-*Patterns*
-
-Every line is a regular expression checked against the file names of existing
-slides. To "unignore" particular slides, you can prefix your pattern with "!".
-
-```config
-# ignore all slides ending with *.md
-.*\.md
-# unignore 01.html.md
-!01.html.md
-```
-
-
-## Creating slides
-
-### Introduction
-
-You need to decide if you want to create slides in pure HTML or if you want to
-use [`Markdown`](http://daringfireball.net/projects/markdown/syntax). It's up
-to you to make your choice. In most cases you should get along with `Markdown`
-&#9786;. From version `0.6.0` onwards
-[`kramdown`](http://kramdown.gettalong.org/syntax.html) is used to parsed
-Markdown. because it supports "Attribute List Definitions" which can be used,
-to provide HTML-attributes to Markdown-elements. Something similar to what
-[reveal.js](https://github.com/hakimel/reveal.js/#element-attributes) does.
-
-### Grouping Slides
-<a name="grouping_slides"></a>
-
-`reveal.js` has a feature called "vertical slides". You can use this to add
-"additional" slides to your presentation to add some auxiliary information.
-To use this feature you need to place slides grouped together in a directory.
-
-```
-# Single slide without namespace
-01.html.erb
-
-# Group "02_hello" of three slides namespace by 02_hello
-02_hello/01.html.erb
-02_hello/02.html.erb
-02_hello/03.html.erb
-
-# Group "03_world" of two slides namespace by 03_world
-03_world/01.html.erb
-03_world/02.html.erb
-```
-
-If you prefer to use the `slide`-command to create your slides, you can create a
-namespaced slide by using the following synatx:
-
-```
-bundle exec middleman slide 02_hello:01
-```
-
-Those commands will create a directory named `02_hello` and a file named `01.html.erb`.
-
-## Use external resources
-
-I encourage you to use `bower` to make external resources within your presentation
-available. This works fine together with the asset pipeline `middleman` uses:
-[sprockets](https://github.com/sstephenson/sprockets). Just add resources to
-your (existing) `bower.json` and make yourself comfortable with bower:
-http://bower.io/. Reference the resources from within your
-`javascripts/application.js` and/or
-`stylesheets/application.scss`
-
-By using `bower` for external resources you can better separate the slide
-content from your styles.
-
-If you created your presentation using the `middleman-presentation`-command,
-files named "bower.json" and ".bowerrc" should exist. Within "bower.json" you
-define the dependencies of your presentation. The last one can be used to tell
-bower where to store the downloaded components.
-
-To reference your assets you should use helpers. There are helpers avaiable for
-Ruby-code and for Sass-code.
-
-* `asset_path(type, name)`, `asset_url(type, name)`:
-
-To reference an arbitrary type you can use the both *ruby* helpers mentioned above. To
-reference a JavaScript-file use `asset_path(:js,
-'<component>/<path>/<file>.js')`.
-
-* `font-path(name)`, `font-url(name)`, `image-path(name)`, `image-url(name)`:
-
-The helpers above can be used to reference assets in Sass-files. You need to
-provide name to reference the asset, e.g.
-`font-path('<component>/<path>/<file>.ttf')`.
-
-To import Css- and Sass-files you should use the `@import`-command. To import
-JavaScript-files from JavaScript-files you should use the `//=
-require`-command.
-
-Please see [sass](http://sass-lang.com/documentation/file.SASS_REFERENCE.html)
-and [sprockets](https://github.com/sstephenson/sprockets) for more information
-about that topic.
-
-## Creating themes
-
-To create your own theme for `middleman-presentation`, you should use the
-`theme`-command. It will create a new directory in the current directory
-(`$PWD`) based on the name for the template, e.g. `new_theme`.
-
-```
-cd my_presentation
-middleman-presentation create theme new_theme
-```
-
-Or if you want to get a more or less empty stylesheet, run it with
-`--clean-css`.
-
-```
-cd my_presentation
-middleman-presentation create theme new_theme --clean-css
-```
-
-After that a directory `new_theme` exists with some sub-directories:
-
-* `javascripts`: Javascript-file go here
-* `stylesheets`: Stylesheets (CSS, SCSS, ..) go here
-* `images`: Image go here
-
-To use your newly created files you need to modify the
-`middleman-presentation`-configuration file and add the following yaml-snippet
-to the file - see [Configuration](#configuration) for more about the
-`middleman-presentation`-configuration file.
-
-```yaml
-theme:
-  name: new_theme
-  github: <github_account>/<repository>
-  javascripts:
-    - javascripts/<name>
-  stylesheets:
-    - stylesheets/<name>
-```
-
-If you prefer to learn by example, look at the default-theme at
-[github](https://github.com/maxmeyer/middleman-presentation-theme-default).
-
-To give you an overview about all css-classes used within templates, issue the
-`style`-command. This will print every available css-class to style existing
-templates. Each of those classes is prefixed with `mp-`.
-
-```bash
-middleman-presentation show style
-# => mp-speaker
-# => [...]
-```
-
-## Creating slide templates
-
-### Normal slide templates
-
-<a name="normal_slide_templates"></a>
-
-To create slides using the `slide`-command templates are used. They are written in
-Eruby (erb). For a good documentation about Eruby see the [Erubis User
-Guide](http://www.kuwata-lab.com/erubis/users-guide.html). Since `0.11.4`. you
-can have your own templates which overwrite the default templates.
-
-You can store those templates in different directories. They are read in the
-given order.
-
-1. presentation local templates (`<presentation root>/templates/<template>`)
-2. user local templates (`~/.config/middleman/presentation/templates/<template>`, `~/.middleman/presentation/templates/<template>`)
-3. system local templates (`/etc/middleman/presentation/templates/<template>`)
-
-
-There are four different templates available:
-
-* Erb (`erb.tt`): Templates for generating `Erb`-slides
-* Markdown (`markdown.tt`): Templates for generating `markdown`-slides
-* Liquid (`liquid.tt`): Templates for generating `liquid`-slides
-* Group (`group.tt`): Templates for groups of slides - see [Grouping Slides](#grouping_slides).
-
-### Custom slide templates
-
-<a name="custom_templates"></a>
-
-Addiontionlly users can define one `custom`-slide-template. It's file extension
-is used for the resulting slide. Given a template `custom.erb.tt` it becomes
-`01.html.erb` when running `middleman slide 01`. 
-
-You may need to add the
-template parser-gem to your `Gemfile` and require it in your `config.rb`.
-
-**Example**
-
-Given you want to create a presentation local custom slide template with haml
-as template language. The created slides should automatically get `.haml` as
-file extension. First you need to create the template directory.
-
-```bash
-# Switch to the directory containing your presentation
-cd my_presentation
-
-# Create template directory
-mkdir -p templates
-```
-
-Next you need to create the template itself using your favourite template
-language. If you want to use information like the presentation title, don't forget the
-template itself is parsed by `Erubis` before it is stored as slide in the file
-system.
-
-*templates/custom.haml.tt*:
-
-```
-%section
-  %h1 Site Title
-  %h2 <%%= title %>
-```
-
-After writing the file to the filesystem you can use it with the
-`slide`-command to create slide by running the following code.
-
-```bash
-# => creates source/slides/01.html.haml
-bundle exec middleman slide 01
-```
-
-If you have more than one "custom"-template the first is one used. The order is
-based on file name.
-
-### Predefined slide templates
-
-There are four predefined slide templates available:
-
-* Start slide
-  * Slide name: `00.html.erb.tt`
-* Questions slide
-  * Slide name: `999980.html.erb.tt`
-* Contact slide
-  * Slide name: `999981.html.erb.tt`
-* End slide
-  * Slide name: `999982.html.erb.tt`
-
-If you place templates in one of the template directories - see [Normal Slide
-Templates](#normal_slide_templates) for the concrete paths -
-`middleman-presentation` will use your templates instead of the ones comming
-with the gem.
-
-If you want to modify the existing predefined slides, run the following command first,
-it will copy the files to
-`~/.config/middleman/presentation/templates/predefined_slides.d`.
-
-```
-middleman-presentation init predefined_slides
-```
-
-## Configuration
-
-<a name="configuration"></a>
-
-`middleman-presentation` will try to find its configuration file at different places:
-
-1. User local: `~/.config/middleman/presentation/presentations.yaml`, `~/.middleman/presentation/presentations.yaml`
-2. System local: `/etc/middleman/presentation/presentations`
-
-To get a full list of available configuration options and their values, run the following command
-
-```
-middleman-presentation show config
-```
-
-To get a full list of available configuration options and their default values, run the following command
-
-```
-middleman-presentation show config --defaults
-```
-
-## Development
-
-Make sure you've got a working internet connection before running the tests. To
-keep the source code repository lean there tests that download assets via bower.
-
-If you care about licensing, please have a look at [LICENSE.txt](LICENSE.txt).
-As this software would not be possible without the wonderful gems out there,
-there's also an overview about all the licenses used by the required gems at
-[doc/licenses/dependencies.html](doc/licenses/dependencies.html). 
-
-If you get some weird errors during testing, make sure have got enough space at
-`/tmp`. This directory is used by `bower` to temporary store downloaded assets.
-
-To check which file consumes the whole space at `/tmp` you can use the following command:
-
-```bash
-# output sizes in mebibytes and sort numerically
-du -ms /tmp/* | sort -n
-```
-
-To find the process which uses this file, run this command:
-
-```bash
-lsof <file>
-```
-
-## Contributing
-
-Please see the [CONTRIBUTING.md](CONTRIBUTING.md) file.
-