https://github.com/gildesmarais/jekyll-blueprint

Blueprint / boilerplate for your new Jekyll site with Github's Actions and deployment on Pages.
https://github.com/gildesmarais/jekyll-blueprint

blueprint boilerplate jekyll jekyll-ecosystem jekyll-website

Last synced: about 1 month ago
JSON representation

Blueprint / boilerplate for your new Jekyll site with Github's Actions and deployment on Pages.

• Host: GitHub
• URL: https://github.com/gildesmarais/jekyll-blueprint
• Owner: gildesmarais
• Archived: true
• Created: 2020-06-12T12:08:07.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2021-05-18T07:11:01.000Z (over 3 years ago)
• Last Synced: 2024-09-25T02:33:51.384Z (about 1 month ago)
• Topics: blueprint, boilerplate, jekyll, jekyll-ecosystem, jekyll-website
• Language: Ruby
• Homepage: https://gildesmarais.github.io/jekyll-blueprint/
• Size: 236 KB
• Stars: 2
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# jekyll-blueprint

A blueprint for a Jekyll project, to be build on Github Actions and deployed to Github Pages per [peaceiris/actions-gh-pages](https://github.com/peaceiris/actions-gh-pages).

Since the site is build on Github Actions, you're not limited to plugins which Github allows via their pages gem.

## Get up and running

- Fork this repo

- `make` sets up the dependencies and starts Jekyll's server

- change/build theme, add content, customize, etc.

- inside `_config.yml`, change `baseurl` to your repository-name

- commit changes + push

- [setup GITHUB_TOKEN](https://github.com/peaceiris/actions-gh-pages#%EF%B8%8F-first-deployment-with-github_token)

- deploy again

- Surf to `https://yourusername.github.io/repository-name/`

## Using your own domain

After you've [setup the DNS of your domain](https://help.github.com/en/github/working-with-github-pages/configuring-a-custom-domain-for-your-github-pages-site),

add a `cname` to `.github/workflows/gh-pages.yml` inside the deploy action.

In `_config.yml`, adjust `url` and `basepath` accordingly.

## Using another theme

### Find a theme

- https://jamstackthemes.dev/ssg/jekyll/

- https://jekyllthemes.io/

- https://jekyll-themes.com/

- ... somewhere on the internet

### Add a theme to your `Gemfile`

If it's published as a gem:

```ruby

gem 'the_theme_to_use'

```

If it's in a github repository:

```ruby

gem 'the_theme_to_use', github: 'username/the_theme_to_use'

```

### Tell Jekyll to use the theme

Inside `_config.yml`, change `theme:` value to `the_theme_to_use`.