Code Monkey home page Code Monkey logo

gatsby-ghost-balsa-starter's Introduction

Draftbox

gatsby-ghost-balsa-starter

A Gatsby starter for creating blogs from headless Ghost CMS.

Turn your Ghost blog into a lightning fast static website. This Gatsby theme is a front-end replacement of the Ghost Handlebars engine featuring the Balsa skin and functionality. All content is sourced from a headless Ghost 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

  1. Install this starter by running

    gatsby new try-ghost https://github.com/draftbox-co/gatsby-ghost-balsa-starter
  2. Change directory

    cd try-ghost
  3. 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
└── 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 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. package.json: A manifest file for Node.js projects, which includes things like metadata (the project’s name, author, etc). This manifest is how npm knows which packages to install for your project.

  7. README.md: A text file containing useful reference information about your project.

Configure

    //siteConfig.js
    module.exports = {
        siteUrl: `https://your-blog.com`, // Do not include a trailing slash!
    
        postsPerPage: 12, //for future use
    
        siteTitleMeta: `Gatsby Starter Ghost CMS`, // This allows an alternative site title for meta data for pages.
        siteDescriptionMeta: `Gastby Starter with Ghost CMS and Casper Skin`, // This allows an 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: `Ghost`, // 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
    }

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.

Ghost Content API keys

All content is sourced from a Ghost CMS. If you don't customize the file .ghost.json content is fetched from the demo location at https://cms.gotsby.org. Surely you want to source your own content. Change the keys to match your own Ghost CMS Content API keys:

    {
        "development": {
            "apiUrl": "http://localhost:2368",
            "contentApiKey": "9fccdb0e4ea5b572e2e5b92942"
        },
        "production": {
            "apiUrl": "http://localhost:2368",
            "contentApiKey": "9fccdb0e4ea5b572e2e5b92942"
        }
    }

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.

Optimizing

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.

Authors

Contributions

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

Copyright & License

Copyright (c) 2020 Draftbox - Released under the MIT license.

gatsby-ghost-balsa-starter's People

Contributors

gunnerforlife avatar shyamlohar avatar thandaanda avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

gatsby-ghost-balsa-starter's Issues

Where do we edit elements?

Hi,
I'm able to build the jamstack site using my content. All good :)

In this example, I would like to edit the nav. I expect to see these within the src:

  • post
  • pages
  • tag
  • author
  • etc

So basically, how can I customize this theme?

Thanks!

Screen Shot 2020-09-25 at 11 15 19 PM

➜  try-ghost git:(master) βœ— gatsby develop
success open and validate gatsby-configs - 0.122s
warn Plugin @draftbox-co/gatsby-plugin-css-variables is not compatible with your
success load plugins - 0.651s
success onPreInit - 0.011s
success initialize cache - 0.008s
success copy gatsby files - 0.053s
warn gatsby-plugin-feed was initialized in gatsby-config.js without a title in a
 feed.
This means that the plugin will use the default feed title, which may not match
your use case.
success onPreBootstrap - 0.023s
success createSchemaCustomization - 0.011s
success source and transform nodes - 0.138s
success building schema - 0.481s
success createPages - 0.093s
success createPagesStatefully - 0.087s
success onPreExtractQueries - 0.003s
success update schema - 0.033s
success extract queries from components - 0.546s
warn The GraphQL query in the non-page component "/Volumes/960G/_pascalandy/11_F
Exported queries are only executed for Page components. It's possible you're
trying to create pages in your gatsby-node.js and that's failing for some
reason.

If the failing component(s) is a regular component and not intended to be a page
component, you generally want to use a <StaticQuery> (https://gatsbyjs.org/docs/static-query)
instead of exporting a page query.

If you're more experienced with GraphQL, you can also export GraphQL
fragments from components and compose the fragments in the Page component
query and pass data down into the child component β€” https://graphql.org/learn/queries/#fragments
success write out requires - 0.067s
success write out redirect data - 0.003s
success onPostBootstrap - 0.001s
β €
info bootstrap finished - 4.963 s
β €
success run queries - 0.182s - 20/21 115.14/s
Warning: Each child in a list should have a unique "key" prop.

Check the top-level render call using <head>. See https://fb.me/react-warning-keys for more information.
    in style
    in HTML
β €
You can now view gatsby-ghost-balsa-starter in the browser.
β €
  http://localhost:8000/
β €
View GraphiQL, an in-browser IDE, to explore your site's data and schema
β €
  http://localhost:8000/___graphql
β €
Note that the development build is not optimized.
To create a production build, use gatsby build
β €
success Building development bundle - 9.353s

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    πŸ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. πŸ“ŠπŸ“ˆπŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❀️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.