インストール

スターターテンプレート

SlidevはNode.js >=14.0で動作します

まずは公式スターターテンプレートを利用してみてください。

NPMで使用する:

$ npm init slidev@latest

Yarnで使用する:

$ yarn create slidev

表示されるプロンプトに従って操作をすると、スライドショーが http://localhost:3030/ で自動的に立ち上がります。

スターターテンプレートには基本的な設定やSlidevの使い方を説明した簡単なデモも収録されています。

マニュアルインストール

Slidevを手動でインストールしたい、または既存のプロジェクトに統合したい場合は、次のようにします:

$ npm install @slidev/cli @slidev/theme-default
$ touch slides.md
$ npx slidev

pnpmを使用している場合、Slidevを正しく動作させるためにshamefully-hoistオプションを有効にする必要があることに注意してください。

echo 'shamefully-hoist=true' >> .npmrc

グローバルインストール

v0.14から使用可能です

以下のコマンドで、Slidevをグローバルにインストール可能です。

$ npm i -g @slidev/cli

毎回プロジェクトを作成することなく、どこでもslidevコマンドを使用できるようになります。

$ slidev

このコマンドはローカルの@slidev/clinode_modulesにあれば、それを実行します。

Docker上にインストールする

コンテナでプレゼンテーションを迅速に実行する必要がある場合、あらかじめ組み込まれているdockerイメージ(メンテナー:stig124)を使うか、あるいは自分でビルドします。

詳しくはslidevjs/container repoを参照してください。