Giter VIP home page Giter VIP logo

gatsby-theme-mdx-tailwind-blog's Introduction

gatsby-theme-mdx-tailwind-blog

LIVE DEMO

This is beta. Things including the style may change without bumping the major version.

Installation

This theme is based on gatsby-theme-mdx-blog.

So you need to install both gatsby-theme-mdx-blog and gatsby-theme-mdx-tailwind-blog.

yarn add gatsby-theme-mdx-blog gatsby-theme-mdx-tailwind-blog

How to use

Configuration

In your gatsby-config.js file,

module.exports = { siteMetadata: { title: Your Title, author: Your Name, description: Your Description, }, plugins: [ gatsby-theme-mdx-blog, gatsby-theme-mdx-tailwind-blog, ], };

Adding posts

Add your posts under

src/pages/your-post.mdx

or

src/pages/your-post/index.mdx

At the frontmatter section, you need the following:

---
title: 'Title of the post'
description: 'Description of the post'
date: 'Date Timestamp'
---

/about page

This theme has a link to /about page in the header.

If you're going to use the theme without modification, then you need to create about.mdx or about.js file. It's in the example.

Syntax Highlighting

You can highlight code syntax.

First, install themes like the following:

yarn add prism-themes

Then, create gatsby-browser.js like this:

import 'prism-themes/themes/prism-darcula.css';

That's it.

Run the example

yarn install && yarn example

All the source code is under examples/blog.

You can also see the live demo here โ†’.

gatsby-theme-mdx-tailwind-blog's People

Contributors

eunjae-lee avatar

Watchers

 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.