uvacoder / deck-starter

deck-starter

Create markdown decks without the tears 🏄‍♂️

---

Table of contents

• Features
• How to use
  • Create using Vercel
  • Create using GitHub templates
  • Create locally using degit
• Workflows
  • Run dev server and open in browser
  • Edit in Visual Studio Code extension
• Deployment
• Suggestions and/or questions
• Maintainers
• License

---

Features

• Powered by Marp ecosystem (Marp CLI, Marp Core, Marpit)
• Ready to deploy anywhere (Vercel, Netlify, any static deployment)
• ...it's just markdown lol

How to use

Create using Vercel

Click the Vercel deploy button above to deploy and create a new deck-starter repository.

Create using GitHub templates

Click the badge above the readme, or visit these links to create a new GitHub repository using this template:

• https://griko.dev/new-deck
• https://github.com/grikomsn/deck-starter/generate

Create locally using degit

npx degit grikomsn/deck-starter [new-directory-name]

Workflows

Run dev server and open in browser

# run dev server on http://localhost:8080
yarn start

# build deck and export in "/public" directory
yarn build

Edit in Visual Studio Code extension

• Extension: Marp for VS Code
• Repository: marp-team/marp-vscode

Deployment

TODO

Suggestions and/or questions

Submit an issue or discuss on GitHub.

Maintainers

• Griko Nibras (@grikomsn)

License

MIT License, Copyright (c) 2021 Griko Nibras