Skip to main content

Generate ODP files from markdown

PyPI version Build Status

Attributions

Original Markdown Copyright (c) 2004-2005 John Gruber http://daringfireball.net/projects/markdown/

Myself got kicked into action by seeing https://github.com/puppetlabs/showoff and getting terribly envious by realizing how much of a productivity gain that would be.

Mission

Have a tool like pandoc, latex beamer etc, that you can write (or auto-generate) input for within your favourite hacker's editor, and generate nice-looking slides from. Using your corporation's mandatory, CI-compliant and lovely-artsy Impress template. Including syntax-highlighted code snippets of your latest hack, auto-fitted into the slides.

Installation

Getting ready should be a simple matter of running

python setup.py install

from a terminal.

On Windows, run it via the command prompt (Start ‣ Accessories):

setup.py install

Alternatively, running odpdown directly from the git checkout is also possible, provided you've installed the prerequisites (most significantly mistune, lpod, pygments, lxml and pillow) manually.

Tests

Run tox to run the test suite.

pip install tox
tox -v

Usage

   usage: odpdown [-h] [--version] [-p PAGE] [-n] [-s HIGHLIGHT_STYLE]
                  [-c CODE_FONT_NAME] [--break-master [BREAK_MASTER]]
                  [--content-master [CONTENT_MASTER]]
                  input_md template_odp output_odp

   Convert markdown text into OpenDocument presentations

   positional arguments:
     input_md              Input markdown file
     template_odp          Input ODP template file
     output_odp            Output ODP file

   optional arguments:
     -h, --help            show this help message and exit
     --version             show program's version number and exit
     -p PAGE, --page PAGE  Append markdown after given page. Negative numbers
                           count from the end of the slide stack. [Defaults to
                           -1]
     -n, --no-autofit      Use to disable auto-shrinking font in text boxes, to
                           fit available space.
     -s HIGHLIGHT_STYLE, --highlight-style HIGHLIGHT_STYLE
                           Set pygments color style for syntax-highlighting of
                           code snippets. Available styles in stock pygments are:
                           "default", "emacs", "friendly", and "colorful".
                           [Defaults to colorful]
     -c CODE_FONT_NAME, --code-font-name CODE_FONT_NAME
                           Set font name used for code fragments. [Defaults to
                           "Nimbus Mono L"]
     --break-master [BREAK_MASTER]
                           Use this master page for the 1st level headlines. List
                           available ones if called with empty or unknown name
     --content-master [CONTENT_MASTER]
                           Use this master page for the 2nd level headlines and
                           content. List available ones if called with empty or
                           unknown name

Example

  • Stick your markdown slides into template, use break_slides from the template's master pages for 1st level headings, and content_slides as the master page for 2nd level headings and content:

    odpdown \
       --break-master=break_slides --content-master=content_slides \
       slides.md corp_template.odp out_slides.odp
    
  • Stick a bunch of markdown chapters into template, after slide 1:

    cat intro.md deploy.md tuning.md | \
    odpdown -p 1 - corp_template.odp out_slides.odp
    
  • Stick a bunch of of markdown chapters into existing preso, e.g. to keep a few hand-crafted slides inbetween:

    # intro comes after slide one
    odpdown -p 1 into.md hand_crafted.odp out_slides.odp
    
    # deploy comes after architecture slide, which is slide 2 in
    # hand_crafted.md and 2+10 after intro got added
    odpdown -p 12 deploy.md out_slides.odp out_slides2.odp
    

Have a lot of fun,

-- Thorsten

Metadata

Release files for odpdown 0.5.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for odpdown 0.5.1
File Size Uploaded Provenance Actions
odpdown-0.5.1.tar.gz 4.1 kB Without provenance Details for odpdown-0.5.1.tar.gz

Release files / odpdown-0.5.1.tar.gz

Download URL odpdown-0.5.1.tar.gz
Size 4.1 kB
Tags Source
SHA-256 checksum
How to use checksums
f3241735f15f39b9b96bdd2bcd1ea02ec67021ef1d1f67b52cfadf151370120d
BLAKE2b-256 checksum
How to use checksums
54340ce62d6e056d429cd09cff087ef6af5ea194e0d40936cda2b8bc57d9ec6f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.11.11

Security for odpdown 0.5.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page