https://github.com/codeadamca/github-pages-deploy-jekyll
A sandbox for testing out GutHub Pages and Jekyll.
https://github.com/codeadamca/github-pages-deploy-jekyll
deployment github-pages jekyll markdown
Last synced: about 2 months ago
JSON representation
A sandbox for testing out GutHub Pages and Jekyll.
- Host: GitHub
- URL: https://github.com/codeadamca/github-pages-deploy-jekyll
- Owner: codeadamca
- Created: 2023-06-13T18:16:42.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2025-01-26T21:38:00.000Z (over 1 year ago)
- Last Synced: 2025-03-31T07:18:54.783Z (about 1 year ago)
- Topics: deployment, github-pages, jekyll, markdown
- Language: Ruby
- Homepage:
- Size: 1.52 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# GitHub Pages and Jekyll
> [!Warning]
> This repo is a work in progress!
A sandbox for testing out GutHub Pages and [Jekyll](https://jekyllrb.com/).
## Install Ruby
On a Mac use Homebrew to install Ruby 3.0. A Mac ships with Ruby, but it will be an outdated version.
```sh
brew install ruby@3.0
```
We do want Ruby first in our PATH. Check which verion of Shell you are using:
```sh
echo $SHELL
```
If the result is `/bin/zsc`, run this command:
```sh
echo 'export PATH="/opt/homebrew/opt/ruby/bin:$PATH"' >> ~/.zshrc
```
If the result is `/bin/bash`, run this commant:
```sh
echo 'export PATH="$HOME/.gem/ruby/X.X.0/bin:$PATH"' >> ~/.bash_profile
```
> [!Note]
> The recommendation in your terminal may be slightly different than the above command. Use the version in your terminal.
Close your Terminal and reopen it. Check your version of Ruby:
```sh
ruby -v
```
You should see a version of 3.0 or highter.
## Install Bundler and Jekyll
Run this command to install [Bundler](https://bundler.io/) and [Jekyll](https://jekyllrb.com/):
```sh
gem install --user-install bundler jekyll
```
## Create a Repo
Create a repo for this project and add the following for your `.gitignore`:
```
_site/
.sass-cache/
.jekyll-cache/
.jekyll-metadata
.bundle/
vendor/
.DS_Store
```
## Create a Jekyll Website
Run the following commands:
```sh
bundle init
bundle add jekyll --version "~>4.2"
bundle config set --local path 'vendor/bundle'
bundle install
bundle exec jekyll new --force --skip-bundle .
bundle add webrick
bundle install
bundle update
```
## Start the Jekyll Website
```sh
bundle exec jekyll serve --livereload
```
Open the provided URL in a browser, something like `http://127.0.0.1:4000/`, and start editing!
## Original Theme files
If you wnat to see the original theme files, use this commant:
```sh
open $(bundle info --path minima)
```
> This repo is available to view at:
> [https://jekyll.codeadam.ca](https://jekyll.codeadam.ca).
---
## Repo Resources
- [GitHub Jekyll](https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/about-github-pages-and-jekyll)
- [Jekyll](https://jekyllrb.com/)
