Skip to content

CodexLabs/md2key

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

md2key

Convert your markdown to keynote.

Installation

gem install md2key

Usage

    1. Create a keynote document
    1. Create a first slide as a cover slide
    1. Create a second slide to choose a slide layout
    1. Then execute md2key markdown.md

Features

Basic example

The slides in the movie can be generated with following markdown.
You can separate slides with --- just for readability.

# The presentation
@k0kubun

## Hello world
- I'm takashi kokubun
- This is a pen
  - Nested item is available

## How are you?
- I'm fine thank you

Insert image

# image slide

- This is an example
- You can insert an image

![](/Applications/Keynote.app/Contents/Resources/keynote.help/Contents/Resources/GlobalArt/AppLanding_KeynoteP4.png)

Insert source code

If you have highlight command, you can insert syntax-highlighted source code.
If you don't have it, execute brew install highlight.

# ActiveRecord::Precount

```rb
Tweet.all.precount(:favorites).each do |tweet|
  p tweet.favorites.count
end
# SELECT `tweets`.* FROM `tweets`
# SELECT COUNT(`favorites`.`tweet_id`), `favorites`.`tweet_id` FROM `favorites` ...
```

Insert table

## table

| a | b | c |
|:--|:--|:--|
| 1 | 2 | 3 |

Insert flowchart & sequence diagram

## flowchart & sequence diagram slide

```mermaid
sequenceDiagram
    Alice->Bob: Hello Bob, how are you?
    Note right of Bob: Bob thinks
    Bob-->Alice: I am good thanks!
    Bob-->John the Long: How about you John?
    Bob-->Alice: Checking with John...
    Alice->John the Long: Yes... John, how are you?
    John the Long-->Alice: Better then you!
```

Insert presenter note

# Keynote Speech

- OMG! I'm keynoting! :fearful:

^ Remember, what would Freddie Mercury do? Yes, I'm Freddie! We are the champions!!

Experimental Features

Configure master slide by header level

You can change master slide by header level if you have .md2key.

See #32 for details.

License

MIT License

About

Convert markdown to keynote

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Ruby 70.6%
  • HTML 28.9%
  • Shell 0.5%