divinebovine / vscode-slides

👩‍🏫 VS Code as a presentation tool

👩‍🏫 VS Code Slides

Slides is a Visual Studio Code extension that helps you use your editor as a presentation tool.

This is inspired from André Staltz's post where he explained how you can use VS Code only to give a pleasant, "live coding"-like presentation.

> Give a feedback

Features

• ⚡ Toggle Slides mode with a shortcut
• 🎨 Apply optimized settings for presentation
• 👐 Handy shortcuts to navigate between slides

Toggle Slides mode

Use Ctrl Alt p (⌘ ⌥ p on Mac) to toggle Slides mode.

When you activate Slides, a few things happen:

• Your settings got stored, so they can be reset
• Settings get replaced with others that are optimized for presentation
• All files are open in the alphabetical order, as tabs
• You can navigate between each tab with convenient shortcuts (see below)

When you deactivate Slides, your original settings get restored.

Navigate between tabs (when Slides is active)

Shortcut	Shortcut on Mac	Operation
Ctrl →	⌘ →	Go to next slide
Ctrl ←	⌘ ←	Go to previous slide
Ctrl Esc	⌘ Esc	Deactivate Slides

You can also re-use Toggle Slides mode to deactivate Slides.

Pre-requisite

Slides is opinionated. By default, you'll need to install:

1. The "GitHub Clean White" theme on VS Code
2. The "SF Mono" font on your machine

If you don't want to use these, you can configure Slides theme and font family. Open VS Code settings and search for "slides".

Installation

1. Click on the Extensions icon (usually on the left-hand side of your editor).
2. Search for "Slides".
3. Find the extension in the list and click the install button.

How to use best

1. Create one file per "slide"
2. Name them by number: 01.md, 02.js, 03.01.md, 03.02.png, etc.
3. Toggle Slides before you start your talk 🎤

Tips

• Prefer to keep coding files empty, or with easy content supposed to be known.

Release Notes

Have a look at our CHANGELOG to get the details of all changes between versions.

Versioning

We follow SemVer convention for versionning.

That means our releases use the following format:

<major>.<minor>.<patch>

• Breaking changes bump <major> (and reset <minor> & <patch>)
• Backward compatible changes bump <minor> (and reset <patch>)
• Bug fixes bump <patch>

Contributing

Contributing Guide

Read our contributing guide to learn about our development process, how to propose bugfixes and improvements, and how to build and test your changes to Abracadabra.

Good First Issues

To help you get your feet wet and become familiar with our contribution process, we have a list of good first issues that contains things with a relatively limited scope. This is a great place to get started!

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Nicolas Carlo 💬 💻 📖 👀 🤔

This project follows the all-contributors specification.

Contributions of any kind are welcome!

License

💁 MIT