Skip to content

nirtamir2/obsidian-slidev

Repository files navigation

Obsidian Slidev Plugin

This is obsidian plugin that integrates slidev presentations.

screencast

Installation

  1. Make sure you have node.js installed on your computer or install it.
  2. Install slidev template by following the installation guide or just running npm init slidev@latest and locate your obsidian vault somewhere whitin your slidev project. Make sure to install dependencies npm i.
  3. Change the "dev" script in package.json of your slidev template to "slidev"
  4. Search slidev in the community plugins of obsidian (you can also download the zip file from the latest release in the release page and put it inside <your-vault>/.obsidian/plugins, install it and enable it. Alernatively install this plugin using BRAT.
  5. Change slidev plugin settings
    1. Configure slidev server start command (Depending on your setup it may not work and you can copy-paste the command to the terminal)
      1. Add node path to environment variable PATH or set absolute path of node in the setting initial script.
      2. Paste the path of your slidev template into the Slidev template location. Click verify and make sure the location is valid.
    2. Configure the right port in settings
  6. Now you can execute the command Slidev: open slidev presentation view. If slidev server start does not work click copy the command to terminal and run it.

Contributing

git clone https://github.com/nirtamir2/obsidian-slidev.git Change .env file content to

OUT_DIR="<relative-path-to-your-vault>/.obsidian/plugins/slidev"

Also make sure you have existing folders for dist in this repo, and for your OUT_DIR in your vault (you may need to create <relative-path-to-your-vault>/.obsidian/plugins/slidev folder.

See more common issues here

Credits