Skip to content

Commit 44d7339

Browse files
committed
updated started.yaml, readme and updated underlying package
1 parent 35430c3 commit 44d7339

File tree

4 files changed

+78
-17
lines changed

4 files changed

+78
-17
lines changed

README.md

Lines changed: 64 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,6 @@ Play with the [Demo](https://wp-balsa-preview.draftbox.co) to get a first impres
3030
- Disqus Integration
3131
- Composable and extensible
3232

33-
3433
## Getting Started
3534

3635
1. Install this starter by running
@@ -80,30 +79,83 @@ A quick look at the top-level files and directories you'll see in a Gatsby proje
8079

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

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

85-
9. **`README.md`**: A text file containing useful reference information about your project.
84+
8. **`README.md`**: A text file containing useful reference information about your project.
8685

8786
## Configure
8887

8988
```js
9089
//siteConfig.js
9190
module.exports = {
92-
siteUrl: "http://localhost:9000", // Site domain. Do not include a trailing slash!
91+
siteUrl: "https://wp-balsa-preview.draftbox.co", // Site domain. Do not include a trailing slash!
9392

94-
postsPerPage: 2, // Number of posts shown on paginated pages (changes this requires sometimes to delete the cache)
93+
postsPerPage: 10, // Number of posts shown on paginated pages (changes this requires sometimes to delete the cache)
9594

96-
siteTitleMeta: "Wordpress Gatsby Starter", // This allows an alternative site title for meta data for pages.
97-
siteDescriptionMeta:
98-
"A starter template to build amazing static websites with Wordpress and Gatsby", // This allows an alternative site description for meta data for pages.
95+
siteTitleMeta: "Built with Draftbox", // This allows an alternative site title for meta data for pages.
96+
siteDescriptionMeta: "New-age blogging platform", // This allows an alternative site description for meta data for pages.
9997

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

103-
shortTitle: "Wordpress", // Used for App manifest e.g. Mobile Home Screen
101+
shortTitle: "Built with Draftbox", // Used for App manifest e.g. Mobile Home Screen
104102
siteIcon: "favicon.png", // Logo in /static dir used for SEO, RSS, and App manifest
105103
backgroundColor: "#e9e9e9", // Used for Offline Manifest
106-
themeColor: "#15171A" // Used for Offline Manifest
104+
themeColor: "#15171A", // Used for Offline Manifest
105+
apiUrl: "https://wordpress.theasdfghjkl.com",
106+
subscribeWidget: {
107+
title: "Subscribe to Draftbox",
108+
helpText: "Get the latest posts delivered right to your inbox.",
109+
successMessage: "Thanks for subscribing to Draftbox.",
110+
},
111+
header: {
112+
navigation: [
113+
{
114+
label: "Home",
115+
url: "https://wp-balsa-preview.draftbox.co/",
116+
},
117+
{
118+
label: "Contact",
119+
url: "https://wp-balsa-preview.draftbox.co/contact",
120+
},
121+
],
122+
},
123+
footer: {
124+
copyright: "Built with Draftbox",
125+
navigation: [
126+
{
127+
label: "Home",
128+
url: "https://wp-balsa-preview.draftbox.co/",
129+
},
130+
{
131+
label: "Sitemap",
132+
url: "https://wp-balsa-preview.draftbox.co/sitemap.xml",
133+
},
134+
{
135+
label: "RSS",
136+
url: "https://wp-balsa-preview.draftbox.co/rss.xml",
137+
},
138+
{
139+
label: "Contact",
140+
url: "https://wp-balsa-preview.draftbox.co/contact",
141+
},
142+
{
143+
label: "External Link",
144+
url: "https://spectrum.chat/gatsby-js/themes?tab=posts",
145+
},
146+
],
147+
},
148+
socialLinks: {
149+
twitter: "https://twitter.com/draftboxhq",
150+
facebook: "https://facebook.com/",
151+
instagram: "https://www.instagram.com/",
152+
linkedin: "https://linkedin.com/",
153+
github: "https://github.com/draftbox-co",
154+
},
155+
contactWidget: {
156+
title: "Contact Built with Draftbox",
157+
successMessage: "We’ll get in touch with you soon.",
158+
},
107159
};
108160
```
109161

@@ -142,12 +194,14 @@ If your blog is hosted on wordpress.com you will have to add few extra keys for
142194
After completion of the build process your static site can be found in the `public/` folder. Copy those files over to your webserver.
143195

144196
## Authors
197+
145198
- Arun Priyadarshi ([@Gunnerforlife](https://github.com/Gunnerforlife)) – [Draftbox](https://draftbox.co)
146199
- Keyur Raval ([@thandaanda](https://github.com/thandaanda)) – [Draftbox](https://draftbox.co)
147200
- Shyam Lohar ([@shyamlohar](https://github.com/shyamlohar)) – [Draftbox](https://draftbox.co)
148201
- Tanmay Desai ([@tanmaydesai89](https://github.com/tanmaydesai89)) – [Draftbox](https://draftbox.co)
149202

150203
## Contributions
204+
151205
PRs are welcome! Consider contributing to this project if you are missing feature that is also useful for others.
152206

153207
# Copyright & License

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
"react-dom": "^16.13.0"
1616
},
1717
"dependencies": {
18-
"@draftbox-co/gatsby-wordpress-balsa-theme": "^1.0.19",
18+
"@draftbox-co/gatsby-wordpress-balsa-theme": "^1.0.20",
1919
"dotenv": "^8.2.0",
2020
"gatsby": "2.20.24",
2121
"gatsby-plugin-crisp-chat": "^3.2.2",

starters.yaml

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,18 @@
22
repo: https://github.com/draftbox-co/gatsby-wordpress-balsa-starter
33
description: A Gatsby starter for creating blogs from headless WordPress CMS.
44
tags:
5+
- AMP
56
- Blog
6-
- SEO
7+
- CMS:Headless
78
- CMS:WordPress
8-
- Styling:Other
9+
- Disqus
10+
- Language:TypeScript
11+
- Netlify
912
- Pagination
13+
- PWA
14+
- RSS
15+
- SEO
16+
- Styling:Tailwind
1017
features:
1118
- Balsa Skin by Draftbox
1219
- Data sourcing from headless WordPress

yarn.lock

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -977,10 +977,10 @@
977977
postcss "^7.0.17"
978978
postcss-js "^2.0.1"
979979

980-
"@draftbox-co/gatsby-wordpress-balsa-theme@^1.0.19":
981-
version "1.0.19"
982-
resolved "https://registry.yarnpkg.com/@draftbox-co/gatsby-wordpress-balsa-theme/-/gatsby-wordpress-balsa-theme-1.0.19.tgz#65e862ca5f415a2003a63758aa636ca1a82739f0"
983-
integrity sha512-slSyBvkn/wXHA7XaUaul4VhIF4SZOrBFj4TYwC8jQg01Ti3IYQCeaiNrZZRmaw6c98lOf/+q/rt0a77ORUmndQ==
980+
"@draftbox-co/gatsby-wordpress-balsa-theme@^1.0.20":
981+
version "1.0.20"
982+
resolved "https://registry.yarnpkg.com/@draftbox-co/gatsby-wordpress-balsa-theme/-/gatsby-wordpress-balsa-theme-1.0.20.tgz#7120c3afbf348b39d6d069799e1cd8aee58e7259"
983+
integrity sha512-t4Fw+mkwu3rNCI2A7oJzIv+LRpCqaaW0Y/IaWN6iMSDl770vN2Z9ye35rXD8OCI0mMLk2uIFAGqYRyrB+UpDPA==
984984
dependencies:
985985
"@armada-inc/gatsby-plugin-amp" "^0.2.3"
986986
"@draftbox-co/gatsby-plugin-webfonts" "^1.1.3"

0 commit comments

Comments
 (0)