Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/byanko55/jekyll-theme-satellite

An emotional and adorable blog theme powered by Jekyll.
https://github.com/byanko55/jekyll-theme-satellite

blog-theme github-pages jekyll-theme personal-website

Last synced: about 2 months ago
JSON representation

An emotional and adorable blog theme powered by Jekyll.

Host: GitHub
URL: https://github.com/byanko55/jekyll-theme-satellite
Owner: byanko55
License: mit
Created: 2023-07-12T00:09:12.000Z (over 1 year ago)
Default Branch: master
Last Pushed: 2024-02-05T08:31:57.000Z (11 months ago)
Last Synced: 2024-02-07T09:45:41.390Z (11 months ago)
Topics: blog-theme, github-pages, jekyll-theme, personal-website
Language: JavaScript
Homepage: https://byanko55.github.io/
Size: 8.87 MB
Stars: 0
Watchers: 1
Forks: 1
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        [![CI](https://img.shields.io/badge/Github%20Pages-passing-gold.svg?logo=github)](ci)

[![License: MIT](https://img.shields.io/badge/License-MIT-orange.svg)](https://opensource.org/licenses/MIT)

[![Jekyll](https://img.shields.io/badge/jekyll-%3E%3D%204.3.2-green.svg)](https://jekyllrb.com/)

[![Jekyll](https://img.shields.io/badge/gem%20version-3.2.33-blue.svg)](gem)



  



# Satellite🛰️ - Jekyll blog theme

An emotional and adorable blog theme powered by ***Jekyll***. 

Live demo is available [here](https://byanko55.github.io)

![Demo Page](https://i.ibb.co/h1QF06V/demo.webp)

### Light Mode

![Demo Page-light](https://i.ibb.co/DtDPCpR/white.webp)

### Dark Mode

![Demo Page-dark](https://i.ibb.co/BjsrWg2/dark.webp)

### Fresh and Attractive Design












## Features

* Comment System using *giscus*

* Copy contents of Code Block

* Dark/Light Theme

* Google Analytics

* Hierarchical Categorization

* Mobile friendly design

* Related Posts

* RSS/Sitemap support

* Search Post by Title or Tags

* Syntax Highlighter (*highlight.js*)

* Table of Contents

* Visitor Counter (*goatcounter*)

## Installation

There are two ways to setup this theme:




### Method 1: Build from source (Recommended)

Fork [this repository](https://github.com/byanko55/jekyll-theme-satellite) or download the [source](https://github.com/byanko55/jekyll-theme-satellite/releases) as a zip. 

If you use as destination a repository named USERNAME.github.io, then your url will be https://USERNAME.github.io/.

Otherwise (let's say `myblog`), you need to edit the '*baseurl*' parameter in `_config.yml`. In this case, the root page will be served to "https://USERNAME.github.io/myblog/".

```yml

# set baseurl as "/". ex) baseurl: /myblog

baseurl: /myblog

```




### Method 2: Utilize Gem package

Create a clean site directory (Follow the **Instruction 1~4** described [here](https://jekyllrb.com/docs/)).

The following materials are redundant, so remove them.

* index.markdown

* about.markdown




Then, add this line to your Jekyll site's `Gemfile`:

```bash

gem "jekyll-theme-satellite"

```

You need to replace the initial `_config.yml` file with the [prepared one](https://github.com/byanko55/jekyll-theme-satellite/blob/master/docs/_config.yml).




### Modify your site setting

Now fill in the **site variable** such as blog name, profile image, and social accounts in `_config.yml`.

```yml

title: Example.com

description: "Satellite - jekyll blog theme"

logo_img: "/assets/img/favicon.webp"

profile_img: "/assets/img/profile.jpg"

# Social Links

email: [email protected]

github_username: github

twitter_username: twitter

instagram_username: instagram

linkedin_username: linkedin

facebook_username: facebook

```

### Run site locally

From the site root directory, install the dependencies:

```

bundle install

```

Start a Jekyll service.

```

bundle exec jekyll serve

```

Now open [http://localhost:4000](http://localhost:4000) in your browser.




## Customizing

You can find useful manuals for customizing your site from the below table:

|||

|---|---|

|Posting guidelines|[link](https://github.com/byanko55/jekyll-theme-satellite/blob/master/docs/Posting%20Guide.md)|

|Enabling ***comment system***|[link](https://github.com/byanko55/jekyll-theme-satellite/blob/master/docs/Comment%20System.md)|

|Enabling ***Visitor counter***|[link](https://github.com/byanko55/jekyll-theme-satellite/blob/master/docs/Visitor%20Counter.md)|

## Contribution

If you would like to report a bug or request a new feature, please open [an issue](https://github.com/byanko55/jekyll-theme-satellite/issues) We are open to any kind of feedback or collaboration.




## License

© 2024 *Yankos*. This theme is available as open source under the terms of the [MIT License](https://opensource.org/license/mit/).