Repository files navigation

A small tool to display markdown files as a slideshow.

Try out Rusty Slider online:

• Example slideshows.

Rusty Slider is available for multiple platforms, such as Windows,Linux, MacOS, and the web. Download the latest binary build from github:

https://github.com/ollej/rusty-slider/releases/

The fileassets/rusty-slider.md will be read and split into slides onhorizontal lines:---

At the moment, the markdown supported is headers, paragraphs, code blocks,blockquotes, simple lists and images. Emphasis and strong are supported if thetheme has italic and bold fonts.

Heading level 1 can be used as title page, as it will render in themiddle of the slide and can have a larger font size set by the themeoptionfont_size_header_title.

You may use html comments (<!-- ... -->) in the markdown for anything youdon't want to be shown.

Images can be added to the slideshow by using the image markdown It needs tobe placed on its own at the start of a line, anything else in the sameparagraph will be ignored.

![ignored](assets/image.png)

A default background image can be set in the theme file. In addition to this,it is possible to override this and set a background image per slide. This isdone by adding an image markdown tag withbackground as the title text.

![background](assets/new-background-image.png)

UseLeft/H andRight/L keys or left and right mouse button to moveback and forth between slides.Up/K/Home keys jump to first slide,andDown/J/End keys jump to last slide.

TheS key saves the current slide as a PNG on disk.

On supported platformsC copies the first codeblock to the clipboard.

Use the keyQ orEscape to exit the slideshow.

Press? to show a help screen.

Use flag--automatic N when starting the application to automatically switchslide every N seconds.

The flag--number N can be used to start the slideshow at that slide.

When the command line flag--enable-code-execution is used, it is possibleto run code in code blocks and show the result.

When a code block with a recognized language is showing on a slide, it can beexecuted by pressing theenter key. The output will be added in a new codeblock at the bottom of the slide.

This feature only works when running locally on a machine that has theinterpretator for each language installed. Be careful when using this asthere is no checks done on the shell script.

Only the first code block on a slide can be executed.

• Bash
• Python
• Perl
• Ruby
• Rust

Create a file calledassets/default-theme.json to modify default display values.

If you make your own theme file, and want to share it, I'd be happy to add itto the release.

These are all the available transitions that can be used in the optiontransition.

• bignoise
• blobs
• checkerboard
• circleswipe
• cubicnoise
• curtainsclose
• curtainsopen
• diagonalleft
• diagonalright
• fan
• halftone
• implode
• lines
• maze
• mosaic
• noise
• plasma
• radialin
• radialout
• smoke
• split
• starburst
• stripes
• swipedown
• swipeleft
• swiperight
• swipeup
• swirl
• triangles
• vortex
• waves
• zebra

The following code themes can be set in the config optioncode_theme:

• base16-ocean.dark
• base16-eighties.dark
• base16-mocha.dark
• base16-ocean.light
• InspiredGitHub
• Solarized (dark)
• Solarized (light)

{"background_image":"assets/background.png","background_color":"#753204","heading_color":"#8f4d22","text_color":"#cccccc","align":"right","font":"assets/Amble-Regular.ttf","font_bold":"assets/Amble-Bold.ttf","font_italic":"assets/Amble-Italic.ttf","font_size_header_title":100,"font_size_header_slides":80,"font_size_text":40,"vertical_offset":20.0,"horizontal_offset":100.0,"line_height":2.0,"blockquote_background_color":"#333333","blockquote_padding":20.0,"blockquote_left_quote":"“","blockquote_right_quote":"„","font_code":"assets/Hack-Regular.ttf","font_code_size":20,"code_line_height":1.2,"code_background_color":"#002b36","code_theme":"Solarized (dark)","code_tab_width":2,"bullet":"•","shader":true,"transition":"swirl"}

The command line options can also be used as URL arguments to theweb demo.

A small tool to display markdown files as a slideshow.Usage: rusty_slider [OPTIONS]Options:  -d, --directory <DIRECTORY>    Path to directory to load slideshow files from [default: assets]  -s, --slides <SLIDES>          Markdown files with slides text [default: rusty-slider.md]  -t, --theme <THEME>            File with theme options [default: default-theme.json]  -a, --automatic <AUTOMATIC>    Automatically switch slides every N seconds [default: 0]      --demo-transitions         Switch transitions for every slide  -S, --screenshot <SCREENSHOT>  When taking screenshot, store PNG at this path [default: screenshot.png]      --enable-code-execution    Enable executing code in code blocks  -A, --assets <ASSETS>          Path to directory where application files are loaded from [default: assets]  -n, --number <NUMBER>          Slide number to start at [default: 0]  -h, --help                     Print help information

Copyright 2022 Olle Wreede, released under the MIT License.

By PunchcutApache LicenseVersion 2.0, January 2004http://www.apache.org/licenses/

Copyright Chris SimpkinsSIL OFL 1.1 and Bitstream Vera v0.00https://www.fontsquirrel.com/license/hack

Copyright (c) 2021 TanTanDevMIT License

• ollej @ mastodon
• Rusty Aquarium
• Olle's portfolio