• Stars
    star
    1,042
  • Rank 44,217 (Top 0.9 %)
  • Language
    JavaScript
  • License
    MIT License
  • Created about 6 years ago
  • Updated 8 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

A starter template to build lightning fast websites with Ghost & Gatsby

Gatsby Starter Ghost

A starter template to build lightning fast websites with Ghost & Gatsby

Demo: https://gatsby.ghost.org/

 

gatsby-starter-ghost

 

Installing

# With Gatsby CLI
gatsby new gatsby-starter-ghost https://github.com/TryGhost/gatsby-starter-ghost.git
# From Source
git clone https://github.com/TryGhost/gatsby-starter-ghost.git
cd gatsby-starter-ghost

Then install dependencies

yarn

 

Running

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

gatsby develop

By default, the starter will populate content from a default Ghost install located at https://gatsby.ghost.io.

To use your own install, you will need to edit the .ghost.json config file with your credentials. Change the apiUrl value to the URL of your Ghost site. For Ghost(Pro) customers, this is the Ghost URL ending in .ghost.io, and for people using the self-hosted version of Ghost, it's the same URL used to access your site.

Next, update the contentApiKey value to a key associated with the Ghost site. A key can be provided by creating an integration within Ghost Admin. Navigate to Integrations and click "Add new integration". Name the integration appropriately and click create.

Finally, configure your desired URL in siteConfig.js, so links (e. g. canonical links) are generated correctly. You can also update other default values, such as postsPerPage in this file.

To use this starter without issues, your Ghost installation needs to be at least on version 2.10.0.

The default Ghost version that is used for this starter is 5.x. If your Ghost installation is on a lower version, you will need to pass in a version property in your .ghost.json settings:

Ghost >=2.10.0 <5.0.0

{
    "apiUrl": "https://gatsby.ghost.io",
    "contentApiKey": "9cc5c67c358edfdd81455149d0",
    "version": "v4.0"
}

Ghost >=5.0.0

{
    "apiUrl": "https://gatsby.ghost.io",
    "contentApiKey": "9cc5c67c358edfdd81455149d0"
}

 

Deploying with Netlify

The starter contains three config files specifically for deploying with Netlify. A netlify.toml file for build settings, a /static/_headers file with default security headers set for all routes, and /static/_redirects to set Netlify custom domain redirects.

To deploy to your Netlify account, hit the button below.

Deploy to Netlify

Content API Keys are generally not considered to be sensitive information, they exist so that they can be changed in the event of abuse; so most people commit it directly to their .ghost.json config file. If you prefer to keep this information out of your repository you can remove this config and set Netlify ENV variables for production builds instead.

Once deployed, you can set up a Ghost + Netlify Integration to use deploy hooks from Ghost to trigger Netlify rebuilds. That way, any time data changes in Ghost, your site will rebuild on Netlify.

 

Optimising

You can disable the default Ghost Handlebars Theme front-end by enabling the Make this site private flag within your Ghost 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.

 

Extra options

# Run a production build, locally
gatsby build

# Serve a production build, locally
gatsby serve

Gatsby develop uses the development config in .ghost.json - while Gatsby build uses the production config.

 

Copyright & License

Copyright (c) 2013-2022 Ghost Foundation - Released under the MIT license.

More Repositories

1

Ghost

Independent technology for modern publishing, memberships, subscriptions and newsletters.
JavaScript
44,370
star
2

node-sqlite3

SQLite3 bindings for Node.js
PLpgSQL
6,218
star
3

Casper

The default theme for Ghost
CSS
2,535
star
4

Admin

Ghost's admin client
JavaScript
627
star
5

express-hbs

Express handlebars template engine with inheritance, partials, i18n and async helpers.
JavaScript
458
star
6

Ghost-CLI

CLI Tool for installing & updating Ghost
JavaScript
433
star
7

Starter

A development starter theme for Ghost
CSS
359
star
8

eleventy-starter-ghost

A starter template to build websites with Ghost & Eleventy
Nunjucks
335
star
9

action-deploy-theme

:octocat: Deploy your Ghost theme with Github Actions
JavaScript
335
star
10

Dawn

A minimal newsletter theme for Ghost
CSS
263
star
11

London

A free, open source theme for Ghost
Handlebars
258
star
12

Ghost-Android

🤖 Ghost for Android
Java
237
star
13

Ghost-Vagrant

Vagrant setup for developing Ghost
Puppet
226
star
14

Massively

A free, open source theme for Ghost
SCSS
216
star
15

Editorial

A free, open source theme for Ghost
SCSS
185
star
16

gatsby-source-ghost

Source plugin for pulling data into Gatsby.js from the Ghost Public API.
JavaScript
176
star
17

Lyra

A paid-members theme for Ghost
CSS
176
star
18

Roon

The official Roon theme for Ghost
CSS
142
star
19

Koenig

Components of Ghost's Editor
JavaScript
116
star
20

Alto

A clean, minimalist theme featuring a light and dark mode for Ghost
Handlebars
113
star
21

docs

Ghost's official documentation
JavaScript
112
star
22

Ghost-App

Includes for Ghost Apps
JavaScript
111
star
23

knex-migrator

DB migration tool for knex.js
JavaScript
100
star
24

SDK

Tools for working with Ghost's APIs
JavaScript
100
star
25

Ghost-Config

Cross-platform meta data and configurations
JavaScript
82
star
26

Ease

A minimal documentation theme for Ghost
Handlebars
80
star
27

generator-ghost

Generate Ghost blogs and themes using Yeoman.
JavaScript
78
star
28

gscan

Ghost theme scanner - checks for errors and feature support
JavaScript
75
star
29

Edge

A visually aesthetic portfolio theme for Ghost
Handlebars
73
star
30

Edition

The newsletter theme for Ghost
JavaScript
73
star
31

Pico

A paid members publishing theme for Ghost
CSS
69
star
32

Themes

A monorepo for Ghost themes
Handlebars
67
star
33

Wave

A podcast theme for Ghost
Handlebars
66
star
34

Portal

Drop-in script to add membership features in a Ghost theme
JavaScript
56
star
35

Source

The default theme for Ghost
CSS
54
star
36

Dope

A unique tag-based theme for Ghost
CSS
53
star
37

Ruby

A multi-column theme with a unique card layout for Ghost
Handlebars
44
star
38

Headline

A local news theme for Ghost
Handlebars
41
star
39

Journal

A newsletter theme for Ghost
Handlebars
41
star
40

GQL

Filter query language for working with Ghost's API
JavaScript
39
star
41

nodecmsguide

Your guide to Node.js content management systems
JavaScript
37
star
42

Slimer-hubot

A bot who lives in IRC
CoffeeScript
36
star
43

wp-ghost-exporter

A WordPress plugin to export content to Ghost
PHP
30
star
44

Solo

A personal theme for Ghost
Handlebars
29
star
45

migrate

JavaScript
27
star
46

Members

JavaScript
24
star
47

Ghost-Editor

Ghost's Mobiledoc Editor
23
star
48

Argon

A simple publishing theme for Ghost
CSS
22
star
49

api-demos

Demo scripts showing how to use Ghost's Admin and Content APIs to accomplish common tasks.
JavaScript
22
star
50

gctools

Command line utilities for working with Ghost content
JavaScript
20
star
51

framework

A collection of handy components for building Node.js applications
JavaScript
20
star
52

bookshelf-relations

A bookshelf plugin which handles relationships.
JavaScript
18
star
53

Tribeca

A free theme for Ghost
CSS
16
star
54

Ignition

Basic configuration and tooling shared across applications
JavaScript
16
star
55

algolia

JavaScript
16
star
56

Ghost-Storage-Base

Base storage adapter for Ghost
JavaScript
14
star
57

Utils

JavaScript
14
star
58

slimer

Tools for working on Ghost & the surrounding ecosystem
JavaScript
11
star
59

vscode

TypeScript
11
star
60

roon-i18n

Roon Internationalization
Ruby
10
star
61

NQL-old

NQL Toolkit: Query data using the NQL Language
JavaScript
9
star
62

action-update-posts

GitHub action for making scheduled changes to posts (e.g. toggling featured)
JavaScript
9
star
63

passport-ghost

Passport adapter for logging in with Ghost.org
JavaScript
8
star
64

Bulletin

A newsletter theme for Ghost
Handlebars
7
star
65

eslint-plugin-ghost

Shared eslint configurations
JavaScript
7
star
66

comments-ui

Drop-in script for comments in Ghost
JavaScript
6
star
67

Digest

A newsletter theme for Ghost
Handlebars
6
star
68

static

Static remote assets for Ghost sites
6
star
69

digitalocean-1-click

DigitalOcean 1-Click App
Shell
6
star
70

action-ghost-release

🚢 GitHub Action to release Ghost
JavaScript
6
star
71

Deploy

Custom shipitjs plugin for deploying
JavaScript
6
star
72

mongo-knex

JavaScript
6
star
73

sodo-search

Drop-in script for search in Ghost
JavaScript
6
star
74

NQL

JavaScript
4
star
75

Zap

An ultra-minimal Ghost theme
CSS
4
star
76

Zapier

Ghost <-> Zapier Integration
JavaScript
4
star
77

slimer-dashboard

GitHub Dashboard built in Apollo
JavaScript
3
star
78

Taste

Handlebars
3
star
79

cropper

JavaScript
2
star
80

nameservers

2
star
81

bunyan-rotating-file-stream

Rotate bunyan logs based on time period and file-size threshold
JavaScript
2
star
82

Actions

GitHub Actions to power Ghost development
JavaScript
2
star
83

label-actions

Tools for managing Ghost's OSS repositories
JavaScript
1
star
84

.github

1
star
85

Analytics

JavaScript
1
star
86

salt-formula-sensu

Salt formula for configuring Sensu.
1
star
87

Core

JavaScript
1
star
88

action-trigger-metric

JavaScript
1
star
89

architecture-diagrams

Set of diagrams and docs explainig architecture of Ghost
1
star