Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/leogopal/gatsby-wp-lgdev

A Gatsby starter for creating blogs from headless WordPress CMS.
https://github.com/leogopal/gatsby-wp-lgdev

Last synced: about 1 month ago
JSON representation

A Gatsby starter for creating blogs from headless WordPress CMS.

Host: GitHub
URL: https://github.com/leogopal/gatsby-wp-lgdev
Owner: leogopal
License: mit
Created: 2021-06-24T07:46:26.000Z (over 3 years ago)
Default Branch: master
Last Pushed: 2021-06-24T08:15:21.000Z (over 3 years ago)
Last Synced: 2024-10-15T20:10:36.125Z (3 months ago)
Language: JavaScript
Size: 1.13 MB
Stars: 1
Watchers: 3
Forks: 0
Open Issues: 1
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

[![Draftbox](https://res.cloudinary.com/thinkcdnimages/image/upload/v1589291053/Draftbox/draftbox-for-github.svg)](https://draftbox.co)

# gatsby-wordpress-theme-libre

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

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

> This starter is being used at [Draftbox](https://draftbox.co). 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](https://wp-libre-preview.draftbox.co/) to get a first impression.

## Features

- WordPress Libre 2 skin
- 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

1. Install this starter by running

```bash
gatsby new wp-starter https://github.com/draftbox-co/gatsby-wordpress-libre-starter
```

2. Change directory

```bash
cd wp-starter
```

3. Run

```bash
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

1. **`/node_modules`**: This directory contains all of the modules of code that your project depends on (npm packages) are automatically installed.

2. **`/static`**: This directory will contain all of the static files required by theme such as `favicon`, `logo` and `robot.txt`.

3. **`.gitignore`**: This file tells git which files it should not track / not maintain a version history for.

4. **`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](https://www.gatsbyjs.org/docs/gatsby-config/) for more detail).

5. **`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).**

6. **`siteConfig`**: A config file for your website, which includes things like website url, title, Background color, theme color etc.

7. **`.wordpress-config.json`**: A config file containing config required to fetch data from wordpress such as url and content keys etc.

8. **`README.md`**: A text file containing useful reference information about your project.

## Configure

```js
//siteConfig.js
module.exports = {
siteUrl: "https://wp-libre-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-libre-preview.draftbox.co/",
},
{
label: "Contact",
url: "https://wp-libre-preview.draftbox.co/contact",
},
],
},
footer: {
copyright: "Built with Draftbox",
navigation: [
{
label: "Home",
url: "https://wp-libre-preview.draftbox.co/",
},
{
label: "Sitemap",
url: "https://wp-libre-preview.draftbox.co/sitemap.xml",
},
{
label: "RSS",
url: "https://wp-libre-preview.draftbox.co/rss.xml",
},
{
label: "Contact",
url: "https://wp-libre-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

```bash
{
"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](https://www.gatsbyjs.org/packages/gatsby-source-wordpress/).

## Deploy

```bash
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](https://github.com/Gunnerforlife)) – [Draftbox](https://draftbox.co)
- Keyur Raval ([@thandaanda](https://github.com/thandaanda)) – [Draftbox](https://draftbox.co)
- Shyam Lohar ([@shyamlohar](https://github.com/shyamlohar)) – [Draftbox](https://draftbox.co)
- Tanmay Desai ([@tanmaydesai89](https://github.com/tanmaydesai89)) – [Draftbox](https://draftbox.co)

## Contributions

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