Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/greglobinski/gatsby-starter-hero-blog
A ready to use, easy to customize, fully equipped GatsbyJS starter with a 'Hero' section on the home page.
https://github.com/greglobinski/gatsby-starter-hero-blog
css-in-js gatsbyjs reactjs styled-jsx
Last synced: about 10 hours ago
JSON representation
A ready to use, easy to customize, fully equipped GatsbyJS starter with a 'Hero' section on the home page.
- Host: GitHub
- URL: https://github.com/greglobinski/gatsby-starter-hero-blog
- Owner: greglobinski
- License: mit
- Archived: true
- Created: 2018-05-10T07:46:20.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-01-11T18:52:11.000Z (over 1 year ago)
- Last Synced: 2024-09-22T15:31:12.063Z (5 days ago)
- Topics: css-in-js, gatsbyjs, reactjs, styled-jsx
- Language: JavaScript
- Homepage: https://gatsby-starter-hero-blog.greglobinski.com/
- Size: 10.8 MB
- Stars: 513
- Watchers: 16
- Forks: 207
- Open Issues: 44
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# HeroBlog
A [GatsbyJS](https://www.gatsbyjs.org/) blog starter.
[](https://github.com/greglobinski/gatsby-starter-personal-blog)
[](https://github.com/greglobinski/gatsby-starter-personal-blog/stargazers)
[](https://github.com/greglobinski/gatsby-starter-personal-blog/blob/master/LICENSE)
[](https://github.com/prettier/prettier)
[](http://makeapullrequest.com)
[](https://twitter.com/intent/tweet?text=Wow:&url=https%3A%2F%2Fgithub.com%2Fgreglobinski%2Fgatsby-starter-hero-blog)
See the starter in action » [demo website](https://gatsby-starter-hero-blog.greglobinski.com/)
For more information visit » [dev.greglobinski.com/gatsby-starter-hero-blog](https://dev.greglobinski.com/gatsby-starter-hero-blog/)
## Description
A ready to use, easy to customize 'like theme' starter with a 'Hero' section on the home page.
The starter was initially built for Gatsby v1. Now, thanks to [@mohsenkhanpour](https://github.com/mohsenkhanpour) it's [upgraded](https://github.com/greglobinski/gatsby-starter-hero-blog/issues/32) to Gatsby v2. Thank you Mohsen :)
The original version of the starter is preserved as the branch `gatsby-v1`.
## Features:
- Easy editable content in **Markdown** files (posts, pages and parts)
- **CSS** with `styled-jsx` and `PostCSS`
- **SEO** (sitemap generation, robot.txt, meta and OpenGraph Tags)
- **Social** sharing (Twitter, Facebook, Google, LinkedIn)
- **Comments** (Facebook)
- **Images** lazy loading and `webp` support (gatsby-image)
- Post **categories** (category based post list)
- Full text **searching** (Algolia)
- **Contact** form (Netlify form handling)
- Form elements and validation with `ant-design`
- **RSS** feed
- 100% **PWA** (manifest.webmanifest, offline support, favicons)
- Google **Analytics**
- App **favicons** generator (node script)
- Easy customizable base **styles** via `theme` object generated from `yaml` file (fonts, colors, sizes)
- React **v.16.3** (gatsby-plugin-react-next)
- **Components** lazy loading (social sharing)
- **ESLint** (google config)
- **Prettier** code styling
- Webpack `BundleAnalyzerPlugin`
- **Gravatar** image (optional) instead local Avatar/Logo image
## Prerequisites
If you do not have Gatsby Cli installed yet, do it first.
```text
npm install --global gatsby-cli
```
More information on [GatsbyJS.org](https://www.gatsbyjs.org/tutorial/part-one)
## Getting started
Install the starter using Gatsby Cli `gatsby new` command.
```text
gatsby new [NEW_SITE_DIRECTORY_FOR_YOUR_BLOG] https://github.com/greglobinski/gatsby-starter-hero-blog.git
```
Go into the newly created directory and run
```text
gatsby develop
```
to hot-serve your website on http://localhost:8000 or
```text
gatsby build
```
to create static site ready to host (/public).
##### External services
The starter uses external services for some functions: comments, searching, analytics. To use them you have to secure some access data. All services are free to use or have generous free tiers big enough for a personal blog.
Create an `.env` file like below in the root folder. Change `...` placeholders with real data.
By default, your `.env` file will be ignored by git. Remove `.env` from `.gitignore` in order to be able to push the file to your repository.
```text
GOOGLE_ANALYTICS_ID=...
ALGOLIA_APP_ID=...
ALGOLIA_SEARCH_ONLY_API_KEY=...
ALGOLIA_ADMIN_API_KEY=...
ALGOLIA_INDEX_NAME=...
FB_APP_ID=...
```
### Instructions & tutorials
- [How to install, setup and add new content to a Blog starter](https://dev.greglobinski.com/install-blog-starter/)
- [Setup Algolia account for your GatsbyJS blog](https://dev.greglobinski.com/setup-algolia-account/)
- More articles at [Front-end web development with Greg](https://dev.greglobinski.com/)
## Windows users
You should take a look at this: [Gatsby on Windows](https://www.gatsbyjs.org/docs/gatsby-on-windows/)
## Authors
- Greg Lobinski [@greglobinski](https://github.com/greglobinski)
See also the list of [contributors](https://github.com/greglobinski/gatsby-starter-personal-blog/graphs/contributors) who participated in this project.
## Contributing
- Fork the repo
- Create your feature branch (git checkout -b feature/fooBar)
- Commit your changes (git commit -am 'Add some fooBar')
- Push to the branch (git push origin feature/fooBar)
- Create a new Pull Request
## Licence
MIT License
Copyright (c) 2017 gatsbyjs
Copyright (c) 2018 greg lobinski
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 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.