Simple Slides

Simple Slides is a small Vue app built with Vite and TypeScript that allows for simple and content-friendly rendering of presentation slides via Markdown.

Simple Slides follows the Takahashi Method of presenting slides, which focuses on:

• Prioritizing text-content
• Low amount of content per slide
• Many slides, and changing through slides quickly

To Install

npm install

To Run

npm run dev # Navigate to http://localhost:5173

# Alternatively, you can run with Docker, but that will generate
# a release build without hot reloading or volume binding,
# which is not ideal for developing.

docker compose up

To Run the Tests

npm test

# Alternatively, for test coverage, run:
npm run test-coverage

To Compile with Typescript

# I mostly use this for linting

npx vue-tsc

Recommended IDE Setup

• VS Code + Volar (and disable Vetur) + TypeScript Vue Plugin (Volar).

Type Support For .vue Imports in TS

TypeScript cannot handle type information for .vue imports by default, so we replace the tsc CLI with vue-tsc for type checking. In editors, we need TypeScript Vue Plugin (Volar) to make the TypeScript language service aware of .vue types.

If the standalone TypeScript plugin doesn't feel fast enough to you, Volar has also implemented a Take Over Mode that is more performant. You can enable it by the following steps:

1. Disable the built-in TypeScript Extension
   1. Run Extensions: Show Built-in Extensions from VSCode's command palette
   2. Find TypeScript and JavaScript Language Features, right click and select Disable (Workspace)
2. Reload the VSCode window by running Developer: Reload Window from the command palette.