https://github.com/marella/jekyll-theme-github

A Jekyll theme for GitHub Pages based on GitHub's Primer styles.
https://github.com/marella/jekyll-theme-github

github-pages jekyll jekyll-theme

Last synced: about 1 month ago
JSON representation

A Jekyll theme for GitHub Pages based on GitHub's Primer styles.

• Host: GitHub
• URL: https://github.com/marella/jekyll-theme-github
• Owner: marella
• License: mit
• Created: 2018-03-25T16:03:39.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2023-07-08T13:06:00.000Z (over 1 year ago)
• Last Synced: 2024-09-29T03:05:20.740Z (about 2 months ago)
• Topics: github-pages, jekyll, jekyll-theme
• Language: SCSS
• Homepage: https://marella.github.io/jekyll-theme-github/
• Size: 421 KB
• Stars: 2
• Watchers: 3
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
A Jekyll theme for GitHub Pages based on GitHub's Primer styles. You can [preview the theme to see what it looks like](https://marella.github.io/jekyll-theme-github/), or even [use it today](#usage).

## Usage

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

    ```yml

    remote_theme: marella/jekyll-theme-github

    ```

1. 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

    ```

## Configuration

The following variables will be used, if set in your site's `_config.yml`:

```yml

title: [The title of your site]

color: [The color of your site's header]

google_analytics: [Your Google Analytics tracking ID]

```

## Development

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

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

1. `cd` into the theme's directory

1. Run `npm install` to install the necessary dependencies

1. Run `npm run build` to compile the sass files and other assets

1. Run `npm start` to start the preview server

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