Giter VIP home page Giter VIP logo

mdx-deck-netlify's Introduction

Example of the slide deck in action

mdx-deck Template

A basic boilerplate to use with mdx-deck with all components and layouts. Different themes and configurations available as feature branches.

Deploy to Netlify

Features

Swap to different themes and configurations by building feature branches (or checkout + merge with production branch).

Development

To run the presentation deck in development mode:

npm start

Edit the deck.mdx file to get started.

Exporting

To build the presentation deck as static HTML:

npm run build

To export a PDF:

npm run pdf

To export an image of the title slide:

npm run image

For more documentation see the mdx-deck repo.

Deploy

Netlify

  1. Clone the project locally and add to your Github
  2. Add the repo to Netlify

or

  1. Click deploy to Netlify on the example repo

โš™๏ธ Netlify settings

In order to make sure our deck deploys properly using continuous integration, we have to configure Netlify to build and display our app.

Go to your Deploy Settings (under the Deploys tab in your Netlify project/repo) and add the following settings:

  1. Set the build script to npm run build
  2. Set the deploy folder to dist

We give Netlify a build script to run each time we make a commit to the repo. And the deploy folder is the place where mdx-deck exports the static HTML/JS version, and by pointing Netlify there it displays our deck after building.

See the demo site here

Credits

mdx-deck-netlify's People

Contributors

whoisryosuke avatar

Stargazers

Ally avatar hh avatar Giancarlo Corzo avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.