ronmi/md-slider repository overview

Markdown to slide

⁠Synopsis

docker run -d --name slider -v /path/to/your/markdown/slides:/data -p 9527:8000 ronmi/md-slider

After that, see http://127.0.0.1:9527⁠

#+TITLE: MD-Slider
#+SUBTITLE: Simple Markdown-to-slides converter inspired by x/tool/present
#+AUTHOR: Ronmi Ren
#+TITLETEXT: **Nerdy** programmer
#+TITLETEXT: Another line of title
#+EMAIL: [email protected]
#+URL: https://81k.today
#+TEXT: [81K Today](https://81k.today)
#+FOOTER: [MD-Slider](https://git.ronmi.tw/ronmi/md-slider)

# First page

## Second page
#+NOTE: my note

some text

- some
- list
- items
#+NOTE: another line of note

# Third page

some more text

#+NOTE: notes for page 3

![gopher](https://blog.golang.org/gopher/header.jpg)

[Copyright information of the gopher image](https://blog.golang.org/gopher)

⁠Markup

Level 1 or 2 headings are marks of page beginning.

All lines before first page mark are metadata.

⁠Metadata

Required tags:

• TITLE: Title of this slide, shows in first page.
• AUTHOR: Your name.
• EMAIL: Your email, shows in last page.

Optional tags:

• FOOTER: One line of markdown text shows at bottom of every page.
• SUBTITLE: Description of slide title, show in first page.
• FACEBOOK: Your Facebook username, shows in last page.
• TWITTER: Your Twitter username (Without @), shows in last page.
• URL: Some url about you, shows in last page.
• TEXT: One line of markdown text about you, shows in last page.
• TITLETEXT: One line of markdown text about you, shows in first page.

⁠Presenter notes

Add #+NOTE: tags to your slides first.

Add a special URL parameter present will enable presenter mode.

// original slides URL
http://127.0.0.1:9527/example.md
// enable presenter mode
http://127.0.0.1:9527/example.md?present=enable

⁠Internal mode

Set environmental variable MD_SLIDER_INTERNAL_MODE=1 to enable it. It enables you to download raw file. Useful when you share md-slider in your office.

⁠License

GPLv3