Skip to content
This repository has been archived by the owner on Jan 2, 2024. It is now read-only.

Commit

Permalink
Initial version of Gatsby Casper Starter
Browse files Browse the repository at this point in the history
Gatsby started based on the gatsby-advanced-starter by Vagr9K. Themed using the Ghost.io Casper theme (v1.4).
  • Loading branch information
haysclark committed Jan 5, 2018
1 parent a336020 commit 1d0fd37
Show file tree
Hide file tree
Showing 115 changed files with 24,003 additions and 11,178 deletions.
35 changes: 20 additions & 15 deletions LICENSE
@@ -1,21 +1,26 @@
MIT License

Copyright (c) 2017-2018 Hays Clark
Copyright (c) 2017 Ruben Harutyunyan
Copyright (c) 2013-2017 Ghost Foundation

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation
files (the "Software"), to deal in the Software without
restriction, including without limitation the rights to use,
copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following
conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.
121 changes: 68 additions & 53 deletions README.md
@@ -1,18 +1,17 @@
[![Code Climate](https://codeclimate.com/github/Vagr9K/gatsby-advanced-starter/badges/gpa.svg)](https://codeclimate.com/github/Vagr9K/gatsby-advanced-starter)
[![Issue Count](https://codeclimate.com/github/Vagr9K/gatsby-advanced-starter/badges/issue_count.svg)](https://codeclimate.com/github/Vagr9K/gatsby-advanced-starter)
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/990fb54ea8094f2aa0ed77f14e859820)](https://www.codacy.com/app/Vagr9K/gatsby-advanced-starter?utm_source=github.com&utm_medium=referral&utm_content=Vagr9K/gatsby-advanced-starter&utm_campaign=Badge_Grade)
[![Code Climate](https://codeclimate.com/github/haysclark/gatsby-starter-casper/badges/gpa.svg)](https://codeclimate.com/github/haysclark/gatsby-starter-casper)
[![Issue Count](https://codeclimate.com/github/haysclark/gatsby-starter-casper/badges/issue_count.svg)](https://codeclimate.com/github/haysclark/gatsby-starter-casper)

<div align="center">
<img src="static/logos/logo-1024.png" alt="Logo" width='200px' height='200px'/>
</div>

# Gatsby Advanced Starter
# Gatsby Casper Starter

A blog starter skeleton with advanced features for [Gatsby](https://github.com/gatsbyjs/gatsby/).
A blog starter skeleton with advanced features for [Gatsby](https://github.com/gatsbyjs/gatsby/) utilizing the [Casper Theme (v1.4)](https://github.com/TryGhost/Casper/tree/1.4) for [Ghost](https://ghost.io/).

## Why?

This project aims to provide a minimal for building GatsbyJS powered blogs.
This project aims to provide a minimal for building GatsbyJS powered blogs which a rather popular theme which has been ported to various platforms.

It doesn't define any UI limitations in any way, and only gives you the basic components for SEO/Social Media/etc.

Expand All @@ -26,7 +25,7 @@ If you are a newcomer to Gatsby who's interested in the implementations of most

If you are interested in a foundation for building ultra-fast websites, you can use this project as a "minimal" starter.

[Demo website.](https://vagr9k.github.io/gatsby-advanced-starter/)
[Demo website.](https://haysclark.github.io/gatsby-starter-casper/)

## Features

Expand All @@ -47,16 +46,19 @@ If you are interested in a foundation for building ultra-fast websites, you can
* Code syntax highlighting
* Embed YouTube videos
* Embed Tweets
* Pages support pagination
* Read More linked paginated pages
* Tags
* Separate page for posts under each tag
* Categories
* Pages support pagination.
* Categories (pages generated but not linked in theme)
* Separate page for posts under each category
* Disqus support
* Disqus support (needs to be uncommented)
* Notifications about new disqus comments
* Google Analytics support
* NPM scripts for GitHub Pages deployment
* Social features
* Twitter tweet button
* Social features (uncomment code to use)
* Twitter tweet button
* Facebook share/share count
* Reddit share/share count
* Google+ share button
Expand Down Expand Up @@ -88,7 +90,7 @@ NOTE: Feel free to check out [Gatsby Material Starter](https://github.com/Vagr9K
Install this starter (assuming [Gatsby](https://github.com/gatsbyjs/gatsby/) is installed) by running from your CLI:

```sh
gatsby new YourProjectName https://github.com/Vagr9K/gatsby-advanced-starter
gatsby new YourProjectName https://github.com/haysclark/gatsby-starter-casper
npm install # or yarn install
npm run develop # or gatsby develop
```
Expand All @@ -98,7 +100,7 @@ Or you can fork the project, make your changes there and merge new features when
Alternatively:

```sh
git clone https://github.com/Vagr9K/gatsby-advanced-starter YourProjectName # Clone the project
git clone https://github.com/haysclark/gatsby-starter-casper YourProjectName # Clone the project
cd YourProjectname
rm -rf .git # So you can have your own changes stored in VCS.
npm install # or yarn install
Expand All @@ -110,52 +112,65 @@ npm run develop # or gatsby develop
Edit the export object in `data/SiteConfig`:

```js
module.exports = {
blogPostDir: 'sample-posts', // The name of directory that contains your posts.
siteTitle: 'Gatsby Advanced Starter', // Site title.
siteTitleAlt: 'GatsbyJS Advanced Starter', // Alternative site title for SEO.
siteLogo: '/logos/logo-1024.png', // Logo used for SEO and manifest.
siteUrl: 'https://vagr9k.github.io', // Domain of your website without pathPrefix.
pathPrefix: '/gatsby-advanced-starter', // Prefixes all links. For cases when deployed to example.github.io/gatsby-advanced-starter/.
siteDescription: 'A blog starter skeleton with advanced features for for GatsbyJS', // Website description used for RSS feeds/meta description tag.
siteRss: '/rss.xml', // Path to the RSS file.
siteFBAppID: '1825356251115265', // FB Application ID for using app insights
disqusShortname: 'https-vagr9k-github-io-gatsby-advanced-starter', // Disqus shortname.
postDefaultCategoryID: 'Tech', // Default category for posts.
userName: 'Advanced User', // Username to display in the author segment.
userTwitter: '', // Optionally renders "Follow Me" in the UserInfo segment.
userLocation: 'North Pole, Earth', // User location to display in the author segment.
userAvatar: 'https://api.adorable.io/avatars/150/test.png', // User avatar to display in the author segment.
userDescription: "Yeah, I like animals better than people sometimes... Especially dogs. Dogs are the best. Every time you come home, they act like they haven't seen you in a year. And the good thing about dogs... is they got different dogs for different people.", // User description to display in the author segment.
// Links to social profiles/projects you want to display in the author segment/navigation bar.
userLinks: [
{
label: 'GitHub',
url: 'https://github.com/Vagr9K/gatsby-advanced-starter',
iconClassName: 'fa fa-github',
},
{
label: 'Twitter',
url: 'https://twitter.com/Vagr9K',
iconClassName: 'fa fa-twitter',
},
{
label: 'Email',
url: 'mailto:vagr9k@gmail.com',
iconClassName: 'fa fa-envelope',
},
],
copyright: "Copyright © 2017. Advanced User", // Copyright string for the footer of the website and RSS feed.
themeColor: "#c62828", // Used for setting manifest and progress theme colors.
backgroundColor: "#e0e0e0" // Used for setting manifest background color.
};
module.exports = {
blogPostDir: "sample-posts", // The name of directory that contains your posts.
blogAuthorDir: "sample-authors", // The name of directory that contains your authors.
blogAuthorId: "casper", // The default and fallback author ID used for blog posts without a defined author.
siteTitle: "Gatsby Casper Starter", // Site title.
siteTitleAlt: "GatsbyJS Casper Theme Starter", // Alternative site title for SEO.
siteLogo: "logos/logo-1024.png", // Logo used for SEO and manifest.
siteUrl: "https://haysclark.github.io", // Domain of your website without pathPrefix.
pathPrefix: "/gatsby-starter-casper", // Prefixes all links. For cases when deployed to example.github.io/gatsby-starter-casper/.
siteDescription:
"A Casper themed GatsbyJS stater based on the Advanced Stater.", // Website description used for RSS feeds/meta description tag.
siteCover: "images/blog-cover.jpg",
siteNavigation: true, // If navigation is enabled the Menu button will be visible
siteRss: "/rss.xml", // Path to the RSS file.
siteRssAuthor: "Casper User", // The author name used in the RSS file
// siteFBAppID: "1825356251115265", // optional, sets the FB Application ID for using app insights
sitePaginationLimit: 10, // The max number of posts per page.
googleAnalyticsID: "UA-111982167-1", // GA tracking ID.
siteSocialUrls: [
"https://github.com/haysclark/gatsby-starter-casper",
"https://twitter.com/gatsbyjs",
"mailto:gatsbyjs@example.com"
],
postDefaultCategoryID: "Tech", // Default category for posts.
// Links to social profiles/projects you want to display in the navigation bar.
userLinks: [
{
label: "GitHub",
url: "https://github.com/haysclark/gatsby-starter-casper",
iconClassName: "fa fa-github" // Disabled, see Navigation.jsx
},
{
label: "Twitter",
url: "https://twitter.com/gatsbyjs",
iconClassName: "fa fa-twitter" // Disabled, see Navigation.jsx
},
{
label: "Email",
url: "mailto:gatsbyjs@example.com",
iconClassName: "fa fa-envelope" // Disabled, see Navigation.jsx
}
],
// Copyright string for the footer of the website and RSS feed.
copyright: {
label: "Gatsby Casper Starter" // label used before the year
// year: "2018" // optional, set specific copyright year or range of years, defaults to current year
// url: "https://www.gatsbyjs.org/" // optional, set link address of copyright, defaults to site root
},
themeColor: "#c62828", // Used for setting manifest and progress theme colors.
backgroundColor: "#e0e0e0", // Used for setting manifest background color.
promoteGatsby: true // Enables the GatsbyJS promotion information in footer.
};
```

You can also optionally set `pathPrefix`:
```js
module.exports = {
// Note: it must *not* have a trailing slash.
pathPrefix: '/gatsby-advanced-starter', // Prefixes all links. For cases when deployed to example.github.io/gatsby-advanced-starter/.
pathPrefix: '/gatsby-starter-casper', // Prefixes all links. For cases when deployed to example.github.io/gatsby-starter-casper/.
}

```
Expand Down
13 changes: 13 additions & 0 deletions content/sample-authors/authors/casper.json
@@ -0,0 +1,13 @@
{
"id": "casper",
"name": "Casper User",
"image": "https://api.adorable.io/avatars/150/test.png",
"url": "http://gatsbyjs.org/",
"location": "North Pole, Earth",
"bio": "Yeah, I like animals better than people sometimes... Especially dogs. Dogs are the best. Every time you come home, they act like they haven't seen you in a year. And the good thing about dogs... is they got different dogs for different people.",
"socialUrls": [
"https://github.com/gatsbyjs",
"https://twitter.com/gatsbyjs",
"mailto:gatsbyjs@example.com"
]
}
8 changes: 8 additions & 0 deletions content/sample-authors/authors/guinevere.json
@@ -0,0 +1,8 @@
{
"id": "guinevere",
"name": "Guinevere Kuiper",
"image": "https://randomuser.me/api/portraits/women/17.jpg",
"url": "https://randomuser.me/api/?seed=user1",
"location": "Simpelveld, Groningen",
"bio": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nullam laoreet lorem nec ligula aliquet, porta blandit augue luctus. Vivamus ac quam diam. Sed vestibulum pharetra hendrerit."
}
3 changes: 2 additions & 1 deletion content/sample-posts/01-01-2017/index.md
@@ -1,6 +1,7 @@
---
title: "Bold Mage"
cover: "https://unsplash.it/400/300/?random?BoldMage"
cover: "https://unsplash.it/1280/500/?random?BoldMage"
author: "guinevere"
date: "01/01/2017"
category: "tech"
tags:
Expand Down
2 changes: 1 addition & 1 deletion content/sample-posts/01-02-2017/index.md
@@ -1,6 +1,6 @@
---
title: "The Fallen Time"
cover: "https://unsplash.it/400/300/?random?TheFallenTime"
cover: "https://unsplash.it/1280/900/?random?TheFallenTime"
date: "01/02/2017"
category: "another one"
tags:
Expand Down
2 changes: 1 addition & 1 deletion content/sample-posts/01-03-2017/index.md
@@ -1,6 +1,6 @@
---
title: "Angels of Mist"
cover: "https://unsplash.it/400/300/?random?AngelsofMist"
cover: "https://unsplash.it/1280/900/?random?AngelsofMist"
category: "test3"
date: "01/03/2017"
tags:
Expand Down
2 changes: 1 addition & 1 deletion content/sample-posts/01-07-2017-Big_Sample_Post/index.md
@@ -1,6 +1,6 @@
---
title: "Big Test"
cover: "https://unsplash.it/400/300/?random?BigTest"
cover: "https://unsplash.it/1280/900/?random?BigTest"
category: "moar"
date: "01/03/2018"
slug: "Big-Sample_Test"
Expand Down
2 changes: 1 addition & 1 deletion content/sample-posts/02-03-2017/index.md
@@ -1,6 +1,6 @@
---
title: "Random project 4 With Super Long Title Phase One"
cover: "https://unsplash.it/1152/300/?random?SuperLong"
cover: "https://unsplash.it/1280/300/?random?SuperLong"
category: "random"
date: "02/03/2017"
tags:
Expand Down
2 changes: 1 addition & 1 deletion content/sample-posts/17-03-2017/index.md
Expand Up @@ -2,7 +2,7 @@
title: "The Butterfly of the Edge"
cover: "https://unsplash.it/1152/300/?random?TheButterflyoftheEdge"
category: "tech"
date: "17/03/2017"
date: "03/17/2017"
tags:
- programming
- more tags
Expand Down
59 changes: 35 additions & 24 deletions data/SiteConfig.js
@@ -1,41 +1,52 @@
module.exports = {
blogPostDir: "sample-posts", // The name of directory that contains your posts.
siteTitle: "Gatsby Advanced Starter", // Site title.
siteTitleAlt: "GatsbyJS Advanced Starter", // Alternative site title for SEO.
siteLogo: "/logos/logo-1024.png", // Logo used for SEO and manifest.
siteUrl: "https://vagr9k.github.io", // Domain of your website without pathPrefix.
pathPrefix: "/gatsby-advanced-starter", // Prefixes all links. For cases when deployed to example.github.io/gatsby-advanced-starter/.
siteDescription: "A GatsbyJS stater with Advanced design in mind.", // Website description used for RSS feeds/meta description tag.
blogAuthorDir: "sample-authors", // The name of directory that contains your authors.
blogAuthorId: "casper", // The default and fallback author ID used for blog posts without a defined author.
siteTitle: "Gatsby Casper Starter", // Site title.
siteTitleAlt: "GatsbyJS Casper Theme Starter", // Alternative site title for SEO.
siteLogo: "https://raw.githubusercontent.com/gatsbyjs/gatsby/master/www/static/android-chrome-512x512.png", // Logo used for SEO and manifest. e.g. "/logos/logo-1024.png",
siteUrl: "https://haysclark.github.io", // Domain of your website without pathPrefix.
pathPrefix: "/gatsby-starter-casper", // Prefixes all links. For cases when deployed to example.github.io/gatsby-starter-casper/.
siteDescription:
"A Casper themed GatsbyJS stater based on the Advanced Starter.", // Website description used for RSS feeds/meta description tag.
siteCover: "https://unsplash.it/1280/500/?random?gatsby-starter-casper", // optional, the cover image used in header for home page. e.g: "/images/blog-cover.jpg",
siteNavigation: true, // If navigation is enabled the Menu button will be visible
siteRss: "/rss.xml", // Path to the RSS file.
siteFBAppID: "1825356251115265", // FB Application ID for using app insights
googleAnalyticsID: "UA-47311644-5", // GA tracking ID.
disqusShortname: "https-vagr9k-github-io-gatsby-advanced-starter", // Disqus shortname.
siteRssAuthor: "Casper User", // The author name used in the RSS file
// siteFBAppID: "1825356251115265", // optional, sets the FB Application ID for using app insights
sitePaginationLimit: 10, // The max number of posts per page.
googleAnalyticsID: "UA-111982167-1", // GA tracking ID.
siteSocialUrls: [
"https://github.com/haysclark/gatsby-starter-casper",
"https://twitter.com/gatsbyjs",
"mailto:gatsbyjs@example.com"
],
postDefaultCategoryID: "Tech", // Default category for posts.
userName: "Advanced User", // Username to display in the author segment.
userTwitter: "", // Optionally renders "Follow Me" in the UserInfo segment.
userLocation: "North Pole, Earth", // User location to display in the author segment.
userAvatar: "https://api.adorable.io/avatars/150/test.png", // User avatar to display in the author segment.
userDescription:
"Yeah, I like animals better than people sometimes... Especially dogs. Dogs are the best. Every time you come home, they act like they haven't seen you in a year. And the good thing about dogs... is they got different dogs for different people.", // User description to display in the author segment.
// Links to social profiles/projects you want to display in the author segment/navigation bar.
// Links to social profiles/projects you want to display in the navigation bar.
userLinks: [
{
label: "GitHub",
url: "https://github.com/Vagr9K/gatsby-advanced-starter",
iconClassName: "fa fa-github"
url: "https://github.com/haysclark/gatsby-starter-casper",
iconClassName: "fa fa-github" // Disabled, see Navigation.jsx
},
{
label: "Twitter",
url: "https://twitter.com/Vagr9K",
iconClassName: "fa fa-twitter"
url: "https://twitter.com/gatsbyjs",
iconClassName: "fa fa-twitter" // Disabled, see Navigation.jsx
},
{
label: "Email",
url: "mailto:vagr9k@gmail.com",
iconClassName: "fa fa-envelope"
url: "mailto:gatsbyjs@example.com",
iconClassName: "fa fa-envelope" // Disabled, see Navigation.jsx
}
],
copyright: "Copyright © 2017. Advanced User", // Copyright string for the footer of the website and RSS feed.
// Copyright string for the footer of the website and RSS feed.
copyright: {
label: "Gatsby Casper Starter" // label used before the year
// year: "2018" // optional, set specific copyright year or range of years, defaults to current year
// url: "https://www.gatsbyjs.org/" // optional, set link address of copyright, defaults to site root
},
themeColor: "#c62828", // Used for setting manifest and progress theme colors.
backgroundColor: "#e0e0e0" // Used for setting manifest background color.
backgroundColor: "#e0e0e0", // Used for setting manifest background color.
promoteGatsby: true // Enables the GatsbyJS promotion information in footer.
};

0 comments on commit 1d0fd37

Please sign in to comment.