snide

Overview

Snide: a remark.js parser in python

• A parser that recognises a slightly modified Markdown slide format parser (todo: ref remarkjs)
  • --- is a slide boundary
  • arbitrary key: value slide configuration
  • ??? for speaker notes

Usage

Install snide:

pip install snide

Use snide in your code to parse a slide markup document:

from snide.models import Deck

deck = Deck(
    'Application To Platform',
    open('application-to-platform.md').read()
)
print(deck.json)
print(deck.title)

for slide in deck.slides:
    print(slide.html)

CLI

TODO: Minimal cli to parse and display deck statistics and meta information

snide my_slides.md

Documentation

API Documentation

Testing

Install development requirements:

pip install -r requirements.txt

Tests can then be run with:

nosetests

Lint the project with:

flake8 changes tests

API documentation

Generate the documentation with:

cd docs && PYTHONPATH=.. make singlehtml

To monitor changes to Python files and execute flake8 and nosetests automatically, execute the following from the root project directory:

stir