Skip to content
Permalink
Browse files

Add mdx-deck Example (#454)

* add mdx-deck starter

* correct typo
  • Loading branch information...
msweeneydev committed Aug 2, 2019
1 parent 50891af commit f3862f4f0a5726d0baa2a1ab6b6e89e0884f21e9
Showing with 74 additions and 1 deletion.
  1. +7 −1 manifest.json
  2. +2 −0 mdx-deck/.gitignore
  3. +2 −0 mdx-deck/.nowignore
  4. +19 −0 mdx-deck/README.md
  5. +24 −0 mdx-deck/deck.mdx
  6. +13 −0 mdx-deck/package.json
  7. +7 −0 mdx-deck/theme.js
@@ -15,7 +15,7 @@
"example": "Nuxt.js",
"path": "/nuxtjs",
"demo": "https://nuxtjs.now-examples.now.sh",
"description": "A Nuxt.js app, bootstrappd with create-nuxt-app."
"description": "A Nuxt.js app, bootstrapped with create-nuxt-app."
},
{
"example": "Create-React-App",
@@ -77,6 +77,12 @@
"demo": "https://docz.now-examples.now.sh",
"description": "A static Docz site that can be expanded upon to create documentation with ease."
},
{
"example": "mdx-deck",
"path": "/mdx-deck",
"demo": "https://mdx-deck.now-examples.now.sh",
"description": "An mdx-deck presentation template that includes a theme."
},
{
"example": "Gridsome",
"path": "/gridsome",
@@ -0,0 +1,2 @@
dist
node_modules
@@ -0,0 +1,2 @@
README.md
yarn.lock
@@ -0,0 +1,19 @@
# mdx-deck Example

This directory is a brief example of a [mdx-deck](https://github.com/jxnblk/mdx-deck) presentation that can be deployed to ZEIT Now with zero configuration.

## How we created this example

To get started with mdx-deck on Now, you can use the [npm init](https://docs.npmjs.com/cli/init) command to initialize the project:

```shell
$ npm init deck my-presentation
```

## Deploying this Example

Once initialized, you can deploy the mdx-deck example with just a single command:

```shell
$ now
```
@@ -0,0 +1,24 @@
import { Head, Notes } from 'mdx-deck'
import { theme } from './theme'

export const themes = [ theme ]

<Head>
<title>Presentation Title</title>
</Head>

# Hello

---

## Edit this file

To create your presentation

<Notes>
Create speaker notes with the Notes component
</Notes>

---

<https://github.com/jxnblk/mdx-deck>
@@ -0,0 +1,13 @@
{
"private": true,
"name": "foo",
"version": "1.0.0",
"scripts": {
"start": "mdx-deck deck.mdx",
"build": "mdx-deck build deck.mdx",
"help": "mdx-deck"
},
"devDependencies": {
"mdx-deck": "^3.0.8"
}
}
@@ -0,0 +1,7 @@
export const theme = {
// Customize your presentation theme here.
//
// Read the docs for more info:
// https://github.com/jxnblk/mdx-deck/blob/master/docs/theming.md
// https://github.com/jxnblk/mdx-deck/blob/master/docs/themes.md
}

1 comment on commit f3862f4

@now

This comment has been minimized.

Copy link

commented on f3862f4 Aug 2, 2019

Please sign in to comment.
You can’t perform that action at this time.