https://github.com/l-nafaryus/jekyll-theme-rocket

:rocket: Rocket is a Jekyll theme for GitHub Pages
https://github.com/l-nafaryus/jekyll-theme-rocket

github-pages jekyll jekyll-theme

Last synced: about 1 month ago
JSON representation

:rocket: Rocket is a Jekyll theme for GitHub Pages

• Host: GitHub
• URL: https://github.com/l-nafaryus/jekyll-theme-rocket
• Owner: L-Nafaryus
• License: cc0-1.0
• Created: 2022-02-06T11:45:00.000Z (almost 3 years ago)
• Default Branch: master
• Last Pushed: 2022-02-08T05:56:48.000Z (almost 3 years ago)
• Last Synced: 2024-04-26T14:05:29.889Z (9 months ago)
• Topics: github-pages, jekyll, jekyll-theme
• Language: SCSS
• Homepage: https://l-nafaryus.github.io/jekyll-theme-rocket/
• Size: 35.2 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# The Rocket theme

[![.github/workflows/ci.yaml](https://github.com/L-Nafaryus/jekyll-theme-rocket/actions/workflows/ci.yaml/badge.svg?branch=master)](https://github.com/L-Nafaryus/jekyll-theme-rocket/actions/workflows/ci.yaml)

*Rocket is a Jekyll theme for GitHub Pages inspired by [rocket.rs](https://rocket.rs) style.*

## Usage

To use the Rocket theme:

1. Add the following to your site's `_config.yml`:

    ```yml

    remote_theme: L-Nafaryus/[email protected]

    plugins:

    - jekyll-remote-theme # add this line to the plugins list if you already have one

    ```

2. Optionally, if you'd like to preview your site on your computer, add the following to your site's `Gemfile`:

    ```ruby

    gem "github-pages", group: :jekyll_plugins

    ```

## Customizing

### Configuration variables

Rocket will respect the following variables, if set in your site's `_config.yml`:

```yml

title: [The title of your site]

description: [A short description of your site's purpose]

```

Additionally, you may choose to set the following optional variables:

```yml

show_downloads: ["true" or "false" (unquoted) to indicate whether to provide a download URL]

google_analytics: [Your Google Analytics tracking ID]

```

### Stylesheet

If you'd like to add your own custom styles:

1. Create a file called `/assets/css/style.scss` in your site

2. Add the following content to the top of the file, exactly as shown:

    ```scss

    ---

    ---

    @import "{{ site.theme }}";

    ```

3. Add any custom CSS (or Sass, including imports) you'd like immediately after the `@import` line

*Note: If you'd like to change the theme's Sass variables, you must set new values before the `@import` line in your stylesheet.*

### Layouts

If you'd like to change the theme's HTML layout:

1. For some changes such as a custom `favicon`, you can add custom files in your local `_includes` folder. The files [provided with the theme](https://github.com/L-Nafaryus/jekyll-theme-rocket/tree/master/_includes) provide a starting point and are included by the [original layout template](https://github.com/L-Nafaryus/jekyll-theme-rocket/blob/master/_layouts/default.html).

2. For more extensive changes, [copy the original template](https://github.com/L-Nafaryus/jekyll-theme-rocket/blob/master/_layouts/default.html) from the theme's repository
(*Pro-tip: click "raw" to make copying easier*)

3. Create a file called `/_layouts/default.html` in your site

4. Paste the default layout content copied in the first step

5. Customize the layout as you'd like

### Customizing Google Analytics code

Google has released several iterations to their Google Analytics code over the years since this theme was first created. If you would like to take advantage of the latest code, paste it into `_includes/head-custom-google-analytics.html` in your Jekyll site.

For more information, see [the Jekyll variables documentation](https://jekyllrb.com/docs/variables/).

### Previewing the theme locally

If you'd like to preview the theme locally (for example, in the process of proposing a change):

1. Clone down the theme's repository (`git clone https://github.com/L-Nafaryus/jekyll-theme-rocket`)

2. `cd` into the theme's directory

3. Run `gem install bundler && bundle install` to install the necessary dependencies

4. Run `bundle exec jekyll serve` to start the preview server

5. Visit [`localhost:4000`](http://localhost:4000) in your browser to preview the theme

### Running build 

The theme contains a minimal test suite, to ensure a site with the theme would build successfully. To run the build, simply run `scripts/build.sh`.