Skip to main content

Simple slide decks with Markdown and Python

Project description

Slidedown

  • Do you ✍️ Slides?
  • Do you 😠 PowerPoint?
  • Do you ❤️ Markdown?

You're in Luck!

Turn markdown like this:

# Step 1

Create an awesome slide deck.

# Step 2

Present it to awesome people.

# Step 3

Profit?

Into slides like this:

How?

  1. Install slidedown with pip
pip install slidedown
  1. Start presenting your markdown files
slidedown README.md
  1. Open up your browser
http://localhost:5678/client/index.html

Interactive Elements

You can embed interactive views into your slides using IDOM, by adding an HTML element into your markup with an attribute of the form data-idom="your_script.py" where your_script.py should be placed in the same directory that slidedown was invoked and must contains a function Main() that returns an IDOM element or a VDOM dict.

IDOM in Slidedown Example

The following markup:

# Hello IDOM!

<span data-idom="hello.py" />

and a script hello.py containing:

import idom


@idom.element
def Main():
    hi_count, set_hi_count = idom.hooks.use_state(1)
    return idom.html.button(
        {"onClick": lambda event: set_hi_count(hi_count + 1)},
        f"IDOM said hi {hi_count} time(s)",
    )

Should produce the following output:

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

slidedown-0.5.0-py3-none-any.whl (8.2 kB view details)

Uploaded Python 3

File details

Details for the file slidedown-0.5.0-py3-none-any.whl.

File metadata

  • Download URL: slidedown-0.5.0-py3-none-any.whl
  • Upload date:
  • Size: 8.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.50.2 CPython/3.8.2

File hashes

Hashes for slidedown-0.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e9719dee2c75d22feacf4e64354ab2b64bbf1b5928cf50970cc5c373c84681a0
MD5 11f86b5b315989471fb1bdb19da0e406
BLAKE2b-256 e4ed77f4a69c53c42aa39760e084852494291555e0c619d3f9141cf30741ddf4

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page