index.rst

Landslide's documentation

Landslide is a command-line based presentation generator relying on Web standards (html, javascript, css) and some Python libraries such as Jinja2, Pygments, docutils and Markdown.

Installation

Landslide requires Python v2.5 minimum and these dependencies installed:

• The Jinja2 template engine
• Pygments for code syntax highlighting

One of the syntax handlers above:

• The Markdown python library if you intend to write your slides contents using the Markdown syntax
• or the docutils package if you rather prefer using reStructuredText.

The easiest way to install Landslide is using Pip:

$ pip install landslide

Alternatively, you can use easy_install:

$ easy_install landslide

If you rather want to stay on the edge:

$ git clone https://github.com/n1k0/landslide.git
$ cd landslide
$ python setup.py build
$ sudo python setup.py install

Basic Usage

Using the Markdown syntax

• Your Markdown source files must be suffixed by .md, .markdn, .mdown or .markdown
• To create a title slide, render a single h1 element (eg. # My Title)
• Separate your slides with a horizontal rule (--- in markdown) except at the end of markdown files
• Your other slides should have a heading that renders to an <h1> or <h2> element
• To highlight blocks of code, put !{lang} where {lang} is the pygment supported language identifier as the first indented line

Here's a sample presentation based on Markdown:

# My Presentation Heading
---
## My First Slide Title
With some contents
---
## My Second Slide Title
With some contents

Using the reStructuredText syntax

Bar

API Documentation

Generator

landslide.generator

Macros

landslide.macro

Parser

landslide.parser

Utils

landslide.utils

Indices and tables

• genindex
• modindex
• search