Installation

To easily create your PWA presentation it is suggested you create your slides using the CLI and the starter kit as described in the

, so you can enjoy all the features.

However, the DeckDeckGo core component could be installed in any project too.

If you wish to do so, use it directly in your project via a CDN. Use a simple script and include, or install it from npm.

Installing the core component as displayed below will "only" install the "engine" of DeckDeckGo respectively, its core doesn't contain any slides.

Splitting the core and the templates allows you to minimize dependencies and, the amount of external code required in your project. Doing this gives the best performance while running the presentation upfront.

Table of contents

• Using DeckDeckGo from a CDN
• Install DeckDeckGo from npm
• Framework integration

Using DeckDeckGo from a CDN

It's recommended to use unpkg as a CDN for the DeckDeckGo core. To do so, add the following include script in the main HTML file of your project:

<script type="module" src="https://unpkg.com/@deckdeckgo/core@latest/dist/deckdeckgo/deckdeckgo.esm.js"></script>
Copy

Install DeckDeckGo from NPM

Install DeckDeckGo in your project from npm using the following command:

npm install @deckdeckgo/core
Copy

Framework integration

The Stencil documentation provides examples of framework integration for Angular, React, Vue and Ember.

That being said, commonly, you might either import or load the component:

Import

import '@deckdeckgo/core';
Copy

Loader

import { defineCustomElements as deckDeckGoElements } from '@deckdeckgo/core/dist/loader';
deckDeckGoElements();
Copy