gatsby-theme-try-ghost

v2.0.2

A Gatsby theme for building flaring fast blogs from headless Ghost CMS. For more information about how to use this package see README

Latest version published 3 years ago

License: MIT

NPM

GitHub

Package Health Score

45 / 100

security
Security review needed
popularity
Limited
maintenance
Inactive
community
Sustainable

Explore Similar Packages

Security

Security review needed

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

All Versions

Version				Vulnerabilities	License Risk
2.0.2	\|	12/2021	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.50.5	\|	02/2021		0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.0.6	\|	02/2020		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

MIT

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Limited

Weekly Downloads (23)

GitHub Stars: 135
Forks: 56
Contributors: 20

Direct Usage Popularity

The npm package gatsby-theme-try-ghost receives a total of 23 downloads a week. As such, we scored gatsby-theme-try-ghost popularity level to be Limited.

Based on project statistics from the GitHub repository for the npm package gatsby-theme-try-ghost, we found that it has been starred 135 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Sustainable

Readme.md: Yes
Contributing.md: Yes
Code of Conduct: No
Contributors: 20
Funding: Yes

With more than 10 contributors for the gatsby-theme-try-ghost repository, this is possibly a sign for a growing and inviting community.

We found a way for you to contribute to the project! Looks like gatsby-theme-try-ghost is missing a Code of Conduct.

Embed Package Health Score Badge

Maintenance

Inactive

archived

Commit Frequency

No Recent Commits

Open Issues: 2
Open PR: 0
Last Release: 3 years ago
Last Commit: 2 years ago

Further analysis of the maintenance status of gatsby-theme-try-ghost based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.

An important project maintenance signal to consider for gatsby-theme-try-ghost is that it hasn't seen any new versions released to npm in the past 12 months, and could be considered as a discontinued project, or that which receives low attention from its maintainers.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: >= 10.13.0

Age: 5 years
Dependencies: 34 Direct
Versions: 162
Install Size: 1.29 MB
Dist-tags: 1
# of Files: 113
Maintainers: 1
TS Typings: No

gatsby-theme-try-ghost has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

gatsby-theme-try-ghost

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

Turn your Ghost blog into a flaring fast static website. This Gatsby theme is a frontend replacement of the Ghost handlebars engine featuring the standard Ghost Casper skin and functionality. All content is sourced from a headless Ghost CMS.

Variants 🔥

Favor Next.js over Gatsby? Head over to next-cms-ghost!

Tutorials ✨ 🆕

> Check out the Tutorials for practical guides on using this project.

Demo

Play with the Demo to get a first impression.

Features

Ghost Casper look and feel
Feature & inline images with lazy-loading and blur-up effect 🚀🚀 🆕
Infinite Scroll ✨
Featured posts pinned on top 🆕
Sticky navigation headers
Hover on author avatar
Styled 404 page
SEO optimized
Fully responsive
Advanced routing 🆕
Composable and extensible
Incremental build enabled 🚀 🆕

Performance

Lighthouse Score

Plugins

Additional features can be integrated by installing Gatsby themes or plugins. The following plugins have been tested to work with gatsby-theme-try-ghost:

Name	Version	Description
`gatsby-theme-ghost-dark-mode`		Dark mode toggle 🌗
`gatsby-rehype-ghost-links`		Rewrite CMS links from absolute to relative
`gatsby-rehype-inline-images` 🆕		Lazy-loading inline images with blur-up
`gatsby-rehype-prismjs`		Syntax highlighting with PrismJS
`gatsby-theme-ghost-contact`		Contact page
`gatsby-theme-ghost-commento`		Commenting system with Commento
`gatsby-theme-ghost-toc` 🆕		Table of Contents
`gatsby-theme-ghost-members` 🆕		Member Subscriptions
`gatsby-plugin-ackee-tracker`		Site tracking with Ackee
`gatsby-plugin-google-analytics`		Site tracking with Google Analytics

Installation

> Head over to the starter repo to get up and running quickly!

If you want to add this blog theme to an existing site, follow these instructions:

Install the blog theme

yarn add gatsby-theme-try-ghost
# or
npm install gatsby-theme-try-ghost --save

Add the following configuration to your gatsby-config.js file

// gatsby-config.js
module.exports = {
    plugins: [
        {
            resolve: `gatsby-theme-try-ghost`,
            options: {
                siteConfig: {
                    siteUrl: `https://your-bog.com`,
                    postsPerPage: 3,
                    siteTitleMeta: `Gatsby frontend powered by headless Ghost CMS`,
                    siteDescriptionMeta: `Turn your Ghost blog into a flaring fast static site with Gatsby`,
                    shortTitle: `Ghost`,
                    siteIcon: `favicon.png`,
                    backgroundColor: `#e9e9e9`,
                    themeColor: `#15171A`,
                    gatsbyImages: true,
                    // Overwrite navigation menu (default: []), label is case sensitive
                    // overwriteGhostNavigation: [{ label: `Home`, url: `/` }],
                },
                ghostConfig: {
                    development: {
                        apiUrl: "https://your-ghost-cms.com",
                        contentApiKey: "9fcfdb1e5ea5b472e2e5b92942",
                    },
                    production: {
                        apiUrl: "https://your-ghost-cms.com",
                        contentApiKey: "9fcfdb1e5ea5b472e2e5b92942",
                    },
                },
                //routes: {
                //    // Root url for Ghost posts and pages (optional, defaults to `/`)
                //    basePath: `/blog`,
                //
                //    // Collections (optional , default: [])
                //    collections: [{
                //        path: `speeches`,
                //        selector: node =&gt; node.primary_tag &amp;&amp; node.primary_tag.slug === `speeches`,
                //    }],
                //},
            },
        },
    ],
};

Update siteConfig

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. Also make sure your favicon.png can be found in folder static of your working directory.
Ghost Content API Keys

Change the apiUrl value to the URL of your Ghost CMS site. Next, update the contentApiKey value to a key associated with the Ghost CMS site. A key can be provided by creating an integration within Ghost Admin. Navigate to Integrations and click Add new integration. Give the integration a name and click create.
Advanced Routing

You can define a basePath that is added to all routes, effectively moving all routes one level down. Collections are distinct groups of posts that get an entry point at collections.path. Permalinks are best configured inroutes.yaml of the Ghost CMS.

Running

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

gatsby develop

Ensure headless mode of Ghost CMS

For best SEO results it is strongly recommended to disable the default Ghost Handlebars theme front-end by selecting the Make this site private flag within your Ghost admin settings. This enables password protection in front of the Ghost install and sets `` so your Gatsby front-end becomes the source of truth for SEO.

Contributions

Special thanks go to the following contributors: jem, tobimori and Torqu3Wr3nch.

PRs are welcome! Consider contributing to this project if you are missing feature that is also useful for others. Explore this guide, to get some more ideas.

Credits

This project would not be possible without the great Gatsby, Ghost, React, GraphQL, Node and the JavaScript eco-system in general. This project started from a fork of gatsby-starter-ghost, but has evolved to a different, independent project.

Copyright & License

gatsby-theme-try-ghost development dependencies

babel-eslint eslint eslint-plugin-ghost eslint-plugin-react react react-dom

FAQs

What is gatsby-theme-try-ghost?

A Gatsby theme for building flaring fast blogs from headless Ghost CMS. Visit Snyk Advisor to see a full health score report for gatsby-theme-try-ghost, including popularity, security, maintenance & community analysis.

Is gatsby-theme-try-ghost popular?

The npm package gatsby-theme-try-ghost receives a total of 23 weekly downloads. As such, gatsby-theme-try-ghost popularity was classified as limited. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is gatsby-theme-try-ghost well maintained?

We found indications that gatsby-theme-try-ghost is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is gatsby-theme-try-ghost safe to use?

While scanning the latest version of gatsby-theme-try-ghost, we found that a security review is needed. A total of 0 vulnerabilities or license issues were detected. See the full security scan results.

Last updated on 15 November-2024, at 08:50 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

Package Health Score

Explore Similar Packages

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Weekly Downloads (23)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Readme

gatsby-theme-try-ghost

Variants 🔥

Tutorials ✨ 🆕

Demo

Features

Performance

Plugins

Installation

Running

Ensure headless mode of Ghost CMS

Contributions

Credits

Copyright & License

gatsby-theme-try-ghost dependencies

gatsby-theme-try-ghost development dependencies

FAQs

What is gatsby-theme-try-ghost?

Is gatsby-theme-try-ghost popular?

Is gatsby-theme-try-ghost well maintained?

Is gatsby-theme-try-ghost safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues