gatsby-wordpress-balsa-starter

A Gatsby starter for creating blogs from headless WordPress CMS with Balsa theme from Draftbox.

Turn your WordPress blog into a lightning fast static website. This Gatsby theme is a frontend replacement of the WordPress engine featuring the Balsa theme skin and functionality. All content is sourced from a headless WordPress CMS.

This starter is being used at Draftbox. Get lightning fast, secure front-end for your WordPress or Ghost blog, in 5 minutes or less, without coding. For our fellow devs, we also provide code export feature.

Demo

Play with the Demo to get a first impression.

Features

Balsa Skin from Draftbox
SEO optimized
Fully responsive
Gatsby images
Styled 404 page
RSS Feed
AMP Pages
Sitemap
Contact Form
Subscribe Form
Social Sharing
Google Analytics Integration
Segment Integration
Disqus Integration
Composable and extensible

Getting Started

Install this starter by running

gatsby new wp-starter https://github.com/draftbox-co/gatsby-wordpress-balsa-starter

Change directory
```
cd wp-starter
```
Run
```
gatsby develop
```
and visit your site at http://localhost:8000.

🧐 What's inside?

A quick look at the top-level files and directories you'll see in a Gatsby project.

.
├── node_modules
├── static
├── .gitignore
├── gatsby-config.js
├── yarn.lock
├── package.json
├── siteConfig.js
├── .wordpress-config.json
└── README.md

/node_modules: This directory contains all of the modules of code that your project depends on (npm packages) are automatically installed.
/static: This directory will contain all of the static files required by theme such as favicon, logo and robot.txt.
.gitignore: This file tells git which files it should not track / not maintain a version history for.
gatsby-config.js: This is the main configuration file for a Gatsby site. This is where you can specify information about your site (metadata) like the site title and description, which Gatsby plugins you’d like to include, etc. (Check out the config docs for more detail).
yarn.lock (See yarn.lock below, first). This is an automatically generated file based on the exact versions of your npm dependencies that were installed for your project. (You won’t change this file directly).
siteConfig: A config file for your website, which includes things like website url, title, Background color, theme color etc.
.wordpress-config.json: A config file containing config required to fetch data from wordpress such as url and content keys etc.
README.md: A text file containing useful reference information about your project.

Configure

//siteConfig.js
module.exports = {
  siteUrl: "https://wp-balsa-preview.draftbox.co", // Site domain. Do not include a trailing slash!

  postsPerPage: 10, // Number of posts shown on paginated pages (changes this requires sometimes to delete the cache)

  siteTitleMeta: "Built with Draftbox", // This allows an alternative site title for meta data for pages.
  siteDescriptionMeta: "New-age blogging platform", // This allows an alternative site description for meta data for pages.

  shareImageWidth: 1000, // Change to the width of your default share image
  shareImageHeight: 523, // Change to the height of your default share image

  shortTitle: "Built with Draftbox", // Used for App manifest e.g. Mobile Home Screen
  siteIcon: "favicon.png", // Logo in /static dir used for SEO, RSS, and App manifest
  backgroundColor: "#e9e9e9", // Used for Offline Manifest
  themeColor: "#15171A", // Used for Offline Manifest
  apiUrl: "https://wordpress.theasdfghjkl.com",
  subscribeWidget: {
    title: "Subscribe to Draftbox",
    helpText: "Get the latest posts delivered right to your inbox.",
    successMessage: "Thanks for subscribing to Draftbox.",
  },
  header: {
    navigation: [
      {
        label: "Home",
        url: "https://wp-balsa-preview.draftbox.co/",
      },
      {
        label: "Contact",
        url: "https://wp-balsa-preview.draftbox.co/contact",
      },
    ],
  },
  footer: {
    copyright: "Built with Draftbox",
    navigation: [
      {
        label: "Home",
        url: "https://wp-balsa-preview.draftbox.co/",
      },
      {
        label: "Sitemap",
        url: "https://wp-balsa-preview.draftbox.co/sitemap.xml",
      },
      {
        label: "RSS",
        url: "https://wp-balsa-preview.draftbox.co/rss.xml",
      },
      {
        label: "Contact",
        url: "https://wp-balsa-preview.draftbox.co/contact",
      },
      {
        label: "External Link",
        url: "https://spectrum.chat/gatsby-js/themes?tab=posts",
      },
    ],
  },
  socialLinks: {
    twitter: "https://twitter.com/draftboxhq",
    facebook: "https://facebook.com/",
    instagram: "https://www.instagram.com/",
    linkedin: "https://linkedin.com/",
    github: "https://github.com/draftbox-co",
  },
  contactWidget: {
    title: "Contact Built with Draftbox",
    successMessage: "We’ll get in touch with you soon.",
  },
};

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.

WordPress Content configuration

    {
        "baseUrl": "yourwordpressblog.com",
        "protocol": "https",
        "hostingWPCOM": false,
        "useACF": true,
        "includedRoutes": [
            "**/categories",
            "**/posts",
            "**/pages",
            "**/media",
            "**/tags",
            "**/taxonomies",
            "**/users"
        ]
    }

In the configuration shown above, the most important fields to be changed are baseUrl and hostingWPCOM . Update those with your configuration. example shown above works great for self hosted wordpress.

If your blog is hosted on wordpress.com you will have to add few extra keys for reference check out wordpress-source-docs.

Deploy

    gatsby build

After completion of the build process your static site can be found in the public/ folder. Copy those files over to your webserver.

Authors

Arun Priyadarshi (@Gunnerforlife) – Draftbox
Keyur Raval (@thandaanda) – Draftbox
Shyam Lohar (@shyamlohar) – Draftbox
Tanmay Desai (@tanmaydesai89) – Draftbox

Contributions

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

thedigitaloctopus / gatsby-wordpress-balsa-starter Goto Github PK