Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/migftw/sparrowx
Minimal, SEO-friendly, Jekyll + Netlify CMS Boilerplate.
https://github.com/migftw/sparrowx
boilerplate boilerplate-template free jekyll jekyll-theme netlify-cms theme
Last synced: about 1 month ago
JSON representation
Minimal, SEO-friendly, Jekyll + Netlify CMS Boilerplate.
- Host: GitHub
- URL: https://github.com/migftw/sparrowx
- Owner: verfasor
- License: mit
- Created: 2018-10-20T15:11:10.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2022-11-28T03:28:54.000Z (about 2 years ago)
- Last Synced: 2024-08-05T03:06:01.810Z (5 months ago)
- Topics: boilerplate, boilerplate-template, free, jekyll, jekyll-theme, netlify-cms, theme
- Language: SCSS
- Homepage:
- Size: 117 MB
- Stars: 27
- Watchers: 0
- Forks: 25
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
**NOTE: The netlify demo is broken as I don't use the service anymore. The repo should work OOB nonetheless. Please create an issue if it isn't working as intended.**
# SparrowX - Jekyll Netlify CMS Boilerplate
A clean minimal Jekyll theme for SEO-focused writers. The theme loads fast and it's Netlify CMS-ready. SparrowX is a remix of sparrow by [lingxz](https://github.com/lingxz/sparrow).
[Live Demo](https://sparrowx.netlify.app)
- [Features](#features)
- [Install](#install)
- [Up and running with Netlify CMS](#up-and-running-with-netlify-cms)
- [General configuration](#general-configuration)
- [Disqus](#disqus)
- [Google analytics](#google-analytics)
- [Collections](#collections)
- [Pagination](#pagination)
- [Navigation](#navigation)
- [Front matter defaults](#front-matter-defaults)
- [Other](#other)
- [Credits](#credits)
## Screenshot
## Website Speed Test
## Original Sparrow Features
- Fully compatible with Github Pages
- Configurable and responsive multi layer menu, adapted from [slimmenu](https://github.com/adnantopal/slimmenu)
- Disqus integration
- [Font Awesome icons](http://fontawesome.io/) included
- Google analytics
- Social sharing using [rrssb](https://www.rrssb.ml/)
- 404 page included
- Atom feed generated with [jekyll-feed](https://github.com/jekyll/jekyll-feed)
- Pagination enabled for blog using [jekyll-paginate](https://github.com/jekyll/jekyll-paginate)
- Basic SEO with Facebook Open Graph tags and Twitter cards
## SparrowX Features
- Fully compatible with Netlify CMS (one-click setup).
- Added new custom variables like updated, headerimage, feature-img, sitemap and tag.
- The theme renders system font-stack.
- Compressed JS.
- Improved load time and reduced file requests.
- _redirects feature
## Install
Just fork this repo and replace the posts with your own. Also rename the sample poetry collection to replace it with your own collection, or just delete it if you don't need to use collections. The example is poetry, but you can easily revamp this into essays, short stories, portfolio, or whatever your creative work is.
## Up and running with Netlify CMS
[Click here](https://sparrowx.netlify.app/netlify-cms-jekyll-setup) to read the documentation for Netlify CMS.
For customization, see below.
### General configuration
Customize these values in the `_config.yml` file:
```yaml
title : "SparrowX"
description : "A clean minimal Jekyll theme for SEO-focused writers."
favicon : "/assets/images/image.png" # You can use base64 encoded images.
url : "https://sparrowx.m1q.net" # the base hostname & protocol for your site e.g. "https://mmistakes.github.io"
baseurl : "" # the subpath of your site, e.g. "/blog" leave blank if no subpath
# Site Author
author:
name : "Mighil" # appears in the footer and atom feed
```
### Disqus
To activate Disqus, fill in your disqus shortname:
```yaml
comments : true # set it to false to disable comments
disqus:
shortname : your_shortname
```
### Google analytics
Enable google analytics by filling in your tracking ID:
```yaml
analytics:
google:
tracking_id : # add your google tracking id here
```
### Collections
If you are using collections, be sure to replace this with your collection name:
```yaml
collections:
poetry:
output: true
permalink: /:collection/:title/
```
### Pagination
Currently, pagination is set to a the blog page. Unfortunately Jekyll does not yet support pagination on multiple pages.
If you want to paginate on a different page, simply change the `paginate_path` value in the config file and create the relevant page.
```yaml
paginate: 5 # amount of posts to show
paginate_path: "/blog/page:num/"
timezone: # http://en.wikipedia.org/wiki/List_of_tz_database_time_zones
```
### Navigation
You can change the navigation links in `_data/navigation.yml`.
### Front matter defaults
At the bottom of the config file, you can also set [front matter defaults](https://jekyllrb.com/docs/configuration/#front-matter-defaults) so that you don't have to repeat the same front matter for every post. This is an example:
```yaml
# Front matter defaults
defaults:
# _pages
- scope:
path: ""
type: pages
values:
layout: page
comments: false
# _posts
- scope:
path: ""
type: posts
values:
layout: post
comments: true
share: true
# _poetry
- scope:
path: ""
type: poetry
values:
layout: post
share: false
```
### How tags work
You should create specific .md files within ```/tag/``` before using the variable.
### Other
To enhance SEO, you can add your twitter username to `_config.yml`.
You can also add an image path for the `og_image` value in the config file, for a default open graph sharing image. This value can be overridden in individual posts by using **headerimage** variable.
Your default image Netlify CMS uploads will go to /images/.
For the various config options see the [sample config file for the demo site](https://github.com/mighildotcom/sparrowx/blob/master/_config.yml)
The color schemes and fonts can also be customized through scss, by editing the relevant variable in `_variables.scss`.
## Credits
- Base theme sparrow by [lingxz](https://github.com/lingxz/sparrow)
- Icon made by [Freepik](https://www.freepik.com/) from www.flaticon.com