Skip to content

Releases: scratchese/markdeck

version 0.2.0: Export SEO-ready slides

13 Aug 01:38
dc100c1

Choose a tag to compare

New export features

  • --optimize flag to minify bundle and add highly SEO ready metadata
  • puppeteer takes a screenshot of every single page and includes it in the metadata
  • support Facebook open graph and Twitter card preview

Examples

$ deck export --assets ./images --optimize --url https://github.com/amazingandyyy/markdeck/tree/master/demo/docs

Screenshots

  • Share on facebook
    Screen Shot 2019-08-12 at 6 20 53 PM

  • Share on Twitter
    Screen Shot 2019-08-12 at 6 19 20 PM

  • Share on Facebook messenger
    Screen Shot 2019-08-12 at 6 26 11 PM

version 0.1.0: markdeck CLI

12 Aug 04:14

Choose a tag to compare

markdeck CLI tool supports

  • compiling markdown to multiple HTML pages
  • configurable source dir, output dir, local port, static assets dir
  • multiple markdowns to multiple presentations
  • auto updating while change markdown content
  • themes, also can be customized by overriding the CSS

Examples

$ deck
$ deck --src ./my_deck --port 5000 --assets ./statics
$ deck export --src ./my_deck --out ./ready_deck --assets ./statics
# output to docs folder then serve by github pages on docs/
# you can share it! every single page has a sharable URL and its own meta data(with potential open graph info in it - that will be future release)

Build SEO-ready slides with zero configuration.

Demo:

https://www.amazingandyyy.com/markdeck/demo/docs/deck/presentation

Highlights

  • zero configuration, inspired by nextjs
  • SEO ready for every single slide
  • blazing fast
  • no tutorials, only demo
  • force you to focus on content, without worried about fancy animations or layouts

Usage

Install globally

$ npm i -g @amazingandyyy/markdeck

Project structure

leave your markdown under decks/ folder

$ tree .
.
└── decks
    └── presentation.md

Present locally

$ deck
...
# alive on http://localhost:1234/deck/presentation/

Export & Share

$ deck export
$ tree .
.
├── decks
│   └── presentation.md
└── docs
    └── deck
        └── presentation
            └──index.html
            ...

Go to repo setting and turn on Github Pages to serve /docs folder, and the presentation is sharable for free :)

Screenshots

2
3

License

MIT - as always

Markdeck is born on Aug 07, 2019

12 Aug 04:22

Choose a tag to compare

Pre-release

Inspired by Wafflejs's speaker sharing "micro serving your team's culture" by Naha Betra and "Boredom is good, actually" on Aug 07, I made a wish to give a talk on next Wafflejs meetup and gave a speech of whatever. To avoid spending too much time on fancy animation or styles, I found myself hesitating with what presentation tool to start with to build my presentation...

Then I have an idea, why not generate markdown to a presentation, so I can only focus on markdown and let the code do the job to build the presentation.

Markdeck is born, it was called speedeck, then changed to next-deck then soon later ended up with Markdeck, means Markdown to a deck or Mark my deck! I soon find out the potential of this dead simple CLI tool and the generated web-based presentation can be so much powerful in terms of sharability, SEO, customized, and much more.

So here we are, Markdeck is born and release v0.0.1 on Aug 07 then v0.1.0 on Aug 11.