Skip to content

pomber/gatsby-theme-deck-n-blog

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

14 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Deck 'n' Blog

You write the MDX for your mdx-decks, and this Gatsby theme creates the deck and the blog post for you.

Installation

To use this theme in your Gatsby sites, follow these instructions:

  1. Init your Gatsby site

    mkdir my-gastby-site
    cd my-gastby-site
    npm install --save react react-dom gatsby gatsby-theme-deck-n-blog
    npm init -y
  2. Create gatsby-config.js:

    module.exports = {
      plugins: ["gatsby-theme-deck-n-blog"]
    };
  3. Create a deck in decks/my-deck.mdx

    ---
    title: The Title
    date: 1986-02-20
    ---
    
    import { Intro, Content } from "gatsby-theme-deck-n-blog"
    
    <Intro>
    
    This will only appear in the blog post as an intro an as the excerpt.
    
    </Intro>
    
    # Slide 1
    
    <Content>
    
    This will appear in the blog post together with the slide 1
    
    </Content>
    
    ---
    
    # Slide 2
    
    <Content>
    
    This will appear in the blog post together with the slide 2
    
    </Content>
  4. Create another deck (yes, you need to create at least two decks!) in decks/another-deck.mdx

  5. Start your site

    npx gatsby develop