https://github.com/leogopal/gatsby-starter-wordpress
LOOKING FOR MAINTAINER - - - A GatsbyJS starter template that leverages the WordPress API, ACF and more
https://github.com/leogopal/gatsby-starter-wordpress
Last synced: about 1 year ago
JSON representation
LOOKING FOR MAINTAINER - - - A GatsbyJS starter template that leverages the WordPress API, ACF and more
- Host: GitHub
- URL: https://github.com/leogopal/gatsby-starter-wordpress
- Owner: leogopal
- License: mit
- Created: 2021-06-24T09:43:00.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2021-06-24T09:43:13.000Z (almost 5 years ago)
- Last Synced: 2025-01-29T14:45:57.702Z (over 1 year ago)
- Language: JavaScript
- Size: 1.56 MB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Gatsby v2 WordPress Starter
This starter is forked from the
[gatsby-starter-netlify-cms](https://github.com/netlify-templates/gatsby-starter-netlify-cms)
and modified to use WordPress instead of netlify-cms, using the [gatsby-source-wordpress](https://github.com/gatsbyjs/gatsby/tree/master/packages/gatsby-source-wordpress) plugin as the data connector.
Demo: https://gatsby-starter-wordpress.netlify.com/
> **Looking for maintainer**: If you're interested in taking over the maintenance of this starter, please reach out in an issue. We're not working with Gatsby any more (it got way too complicated, hello nextjs), and so we're not maintaining this.
## Use It Now
gatsby new NAME https://github.com/GatsbyCentral/gatsby-starter-wordpress
* Edit `gatsby-config.js`, change `baseUrl`
- Make sure you have at least 1 post and 1 page on your WordPress site
- Make sure at least 1 post has at least 1 tag
* Ensure the permalink structure in your WordPress installation is set to `Post Name` instead of the deafult `Plain`, or else the `gatsby-source-wordpress` plugin won't be able to communicate with WordPress
* Rejoice
- For more information on the source plugin, check out the [gatsby-source-wordpress](https://github.com/gatsbyjs/gatsby/tree/master/packages/gatsby-source-wordpress) repository page
- File any [issues here](https://github.com/GatsbyCentral/gatsby-starter-wordpress/issues)
### Known Limitations
* This is based on the [netlify starter](https://github.com/netlify-templates/gatsby-starter-netlify-cms) which uses [bulma](https://bulma.io). This adds 150KB to every built page.
* Your WordPress site must have at least 1 post with 1 tag, or the starter will crash
* Nested pages / categories will not render with nested pages
- A WordPress page like `/about/team/` will render on Gatsby as `/team/`
- Likewise for categories
- Discussion here https://github.com/GatsbyCentral/gatsby-starter-wordpress/issues/24
## CSS Processing
This plugin uses [gatsby-plugin-purgecss](https://www.gatsbyjs.org/packages/gatsby-plugin-purgecss/) and [bulma](https://bulma.io/). The bulma build would otherwise be ~170K which adds 170K to each of your built HTML pages. However, with purgecss this is reduced 90%.
## WordPress Setup
Check the [gatsby-source-wordpress](https://github.com/gatsbyjs/gatsby/tree/master/packages/gatsby-source-wordpress) plugin for more information. If you want to copy the demo content, you can grab the [WordPress XML export here](https://wpdemo.gatsbycentral.com/gatsbystarterwordpress.WordPress.2019-09-12.xml) and import it into your WordPress site as a starting point.
## Support
Please post support questions on StackOverflow or other similar sites. Please only post issues here if you have a bug to report with a reproduction. Unfortunately we're not able to provide support here.
## Contributors
This starter was forked from the netlify starter by the
[GatsbyCentral](https://www.gatsbycentral.com/) crew. Additional contributions
were gratefully received from the following folks:
* https://github.com/tomByrer
* https://github.com/dajocarter