@amazingandyyy/markdeck NPM

Demo:

https://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
perfect preview on social network(fb/twitter/slack...etc)

Usage

Install globally

$ npm i -g @amazingandyyy/markdeck

Simple Project structure

leave your markdown under decks/ folder

$ tree .
.
└── decks/
    └── presentation.md
    └── presentation.css (the exact same name as markdown, so you can easily override the theme css)

Present locally

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

Export & Share

$ deck export
$ tree .
.
├── decks/
│   └── presentation.md
│   └── images/
│       └── andy.png
└── docs/
    └── deck/
        └── presentation/
            └──index.html
            ...
$ deck export --optimize

Github Pages

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

Production Build / SEO-ready

$ deck export --optimize
<!-- you might also want to setup assets for static assets -->
$ deck export --assets images --url https://github.com/amazingandyyy/markdeck/tree/master/demo/docs --optimize