Gatsby-theme-ghost-reloaded NPM

gatsby-theme-ghost-reloaded

A Gatsby theme plugin for creating blogs from headless Ghost CMS.

Turn your Ghost blog into a flaring fast static website. This Gatsby theme is a frontend replacement of the Ghost handlebars engine featuring the standard Ghost Casper skin and functionality. All content is sourced from a headless Ghost CMS.

Demo

Play with the Demo to get a first impression.

Features

Ghost Casper look and feel
Infinite Scroll ✨ 🆕
Gatsby images 🚀 🆕
Sticky navigation headers
Hover on author avatar
Styled 404 page
SEO optimized
Fully responsive
Advanced routing 🆕
Composable and extensible

Performance

Lighthouse Score

Addons

Additional features can be integrated by installing Gatsby themes or plugins. The following plugins have been tested to work with this repository:

Dark mode toggle with gatsby-theme-ghost-dark-mode 🌗 🆕
Rewrite CMS links to relative with gatsby-rehype-ghost-links
Syntax highlighting with gatsby-rehype-prismjs
Contact page with gatsby-theme-ghost-contact 🆕
Commenting system with gatsby-theme-ghost-commento 🆕
Site tracking with Ackee

Installation

Head over to the starter repo to get up and running quickly!

If you want to add this blog theme to an existing site, follow these instructions:

Install the blog theme

yarn add gatsby-theme-ghost-reloaded
# or
npm install gatsby-theme-ghost-reloaded --save

Add the following configuration to your gatsby-config.js file

// gatsby-config.js
module.exports = {
plugins: [
    {
    resolve: `gatsby-theme-ghost-reloaded`,
    options: {
        siteConfig: {
            siteUrl: `https://your-bog.com`,
            postsPerPage: 3,
            siteTitleMeta: `Gatsby frontend powered by headless Ghost CMS`,
            siteDescriptionMeta: `Turn your Ghost blog into a flaring fast static site with Gatsby`, 
            shareImageWidth: 1000,
            shareImageHeight: 523,
            shortTitle: `Ghost`,
            siteIcon: `favicon.png`,
            backgroundColor: `#e9e9e9`,
            themeColor: `#15171A`,
        },
        ghostConfig: {
            "development": {
                "apiUrl": "http://localhost:2368",
                "contentApiKey": "9fcfdb1e5ea5b472e2e5b92942",
            },
            "production": {
                "apiUrl": "https://your-ghost-cms.com",
                "contentApiKey": "9fcfdb1e5ea5b472e2e5b92942",
            },
        },
      },
   },
],  
}

Update siteConfig
In the configuration shown above, the most important fields to be changed are siteUrl, siteTitleMeta and siteDescriptionMeta. Update at least those to fit your needs. Also make sure your favicon.png can be found in folder static of your working directory.
Ghost Content API Keys
Change the apiUrl value to the URL of your Ghost CMS site. Next, update the contentApiKey value to a key associated with the Ghost CMS site. A key can be provided by creating an integration within Ghost Admin. Navigate to Integrations and click Add new integration. Give the integration a name and click create.

Running

Start the development server. You now have a Gatsby site pulling content from headless Ghost.

gatsby develop

Ensure headless mode of Ghost CMS

For best SEO results it is strongly recommended to disable the default Ghost Handlebars theme front-end by selecting the Make this site private flag within your Ghost admin settings. This enables password protection in front of the Ghost install and sets <meta name="robots" content="noindex" /> so your Gatsby front-end becomes the source of truth for SEO.

Contributions

PRs are welcome! Consider contributing to this project if you are missing feature that is also useful for others.

gatsby-theme-ghost-reloaded v1.0.1