Skip to content

Latest commit

 

History

History
20 lines (14 loc) · 1023 Bytes

CONTRIBUTING.md

File metadata and controls

20 lines (14 loc) · 1023 Bytes

Contributing

Have an issue or feature request, but don't know how to work on the code base?

Feel free to submit an issue.

Want to work on the codebase?

Feel free to do so.

🛠 Prerequisites

  • Git

Optionally (highly recommended)

  • Visual Studio Code
  • Marp Extension for Visual Studio Code

If you do not have either of these, you must have adequate knowledge in how to use Marp in other ways. If your changes aren't breaking, it's all the same regardless.

Instructions

Simply clone or fork the repo, create a branch, and follow the instructions of usage in the readme.

To generate new preview images, run the create-previews.sh script in the example folder (do so while in that directory). You may need to chmod it first. You'll need to have marp-cli installed and be running Linux, and have one of these browsers: Firefox, Chrome (Chromium seems to work fine), or Edge. This is a marp-cli requirement.