Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/seraphroy/gaeblogx

A Jekyll theme for my blog https://gaeblogx.com
https://github.com/seraphroy/gaeblogx

blog jekyll jekyll-blog jekyll-site jekyll-theme jekyll-themes jekyll-website

Last synced: 14 days ago
JSON representation

A Jekyll theme for my blog https://gaeblogx.com

Awesome Lists containing this project

README

        

# Jekyll Theme GaeBlogx

My personal blog Github Page: https://github.com/SeraphRoy/SeraphRoy.github.io

## Major features

- Categories, Tags, Archives
- Site-wide search provided by Algolia and [Simple-Blog-Search](https://github.com/SeraphRoy/SimpleBlogSearch)
- Clean responsive design
- Disqus Comments and Google Analytics support
- SEO best practices via Jekyll SEO Tag
- Archive by month instead of year
- About page layout
- Table of contents

## Installation

If you're running Jekyll v3.5+ and self-hosting you can quickly install the
theme as a Ruby gem. If you're hosting with GitHub Pages you can install as a
remote theme or directly copy all of the files into your project.

First have a `index.html` in your root folder, containing:

```
---
layout: home
paginate: true
---
```

then:

### Ruby Gem Method

1. Add this line to your Jekyll site's `Gemfile`:

```ruby
gem "jekyll-theme-gaeblogx"
```
2. Add this line to your Jekyll site's `_config.yml` file:

```yaml
theme: jekyll-theme-gaeblogx
```

2. Then run [Bundler](https://bundler.io/) to install the theme gem and dependencies:

```terminal
bundle install
```

### GitHub Pages Method

GitHub Pages has added [full support](https://github.com/blog/2464-use-any-theme-with-github-pages)
for any GitHub-hosted theme.

1. Replace `gem "jekyll"` with:

```ruby
gem "github-pages", group: :jekyll_plugins
```

2. Run `bundle update` and verify that all gems install properly.

3. Add `remote_theme: "SeraphRoy/GaeBlogx"` to your
`_config.yml` file. Remove any other `theme:` or `remote_theme:` entries.

# Notes

Please specify Agolia specific configs in `_config.yml`, and other settings as well.

Specify `blogname`, `blogabout`, in `_config.yml`

You can create your own `about` page using `about` layout

For reference, please take a look at my personal settings: https://github.com/SeraphRoy/SeraphRoy.github.io

Credits: https://github.com/Gaohaoyang/gaohaoyang.github.io