bay - GitLite

KO | EN

gitlite — search

#javascript #react #ai #go #golang #machine-learning #deep-learning #macos #awesome #cli #kubernetes #vue #security #open-source

bay

(★ 190)

🐟 A simple theme for Jekyll. Live at https://eliottvincent.github.io/bay/

파일 탐색기

최종 버전 다운로드 (.zip)

- - build.yml
  - deploy.yml
- draft-banner.html
- foot.html
- footer.html
- head.html
- header.html
- wechat-widget.html
- blog.html
- default.html
- home.html
- post.html
- work.html
- 2019-10-26-example-of-blog-post.md
- _base.scss
- _blog.scss
- _extends.scss
- _layout.scss
- _mixins.scss
- _not_found.scss
- _post.scss
- _site.scss
- _variables.scss
- _work.scss
- - main.scss
- - menu.png
  - profile-pic.jpg
  - title.png
  - wechat-qr-code.png
- - site.js
.gitignore
404.md
_config.yml
bay_jekyll_theme.gemspec
blog.md
CHANGELOG.md
favicon.ico
Gemfile
Gemfile.lock
index.md
LICENSE.md
README.md
screenshot.png
work.md

# 설치 가이드

1. 코드 내려받기

git clone https://github.com/eliottvincent/bay

깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.

cd bay

방금 내려받은 프로젝트 폴더 안으로 이동합니다.

2. Ruby

쉬움 추천

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
Ruby bundle 명령어를 쓰려면 Ruby가 필요합니다.

bundle install

Gemfile에 명시된 루비 라이브러리를 설치합니다.

bundle exec jekyll serve

이 명령어를 터미널에 그대로 입력해 실행하세요.

✅ bundle install이 에러 없이 끝나면 README에 안내된 실행 명령어(예: rails server)로 마저 실행해보세요.

이 레포의 README에 적힌 실제 명령어를 그대로 가져왔습니다.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Bay

[![Version](https://img.shields.io/gem/v/bay_jekyll_theme)](https://rubygems.org/gems/bay_jekyll_theme)
[![Downloads](https://img.shields.io/gem/dt/bay_jekyll_theme)](https://rubygems.org/gems/bay_jekyll_theme)

Bay is a simple theme for Jekyll. [[view live]](https://eliottvincent.github.io/bay)

Inspired by [dangrover.com](http://dangrover.com/). Current theme used at [eliottvincent.com](http://eliottvincent.com/).

![](https://raw.githubusercontent.com/eliottvincent/bay/master/screenshot.png)

## Table of contents

1. [Installation](#installation)
2. Website sections
    1. [Header](#header)
    2. [Footer](#footer)
    3. [Home page](#home-page)
    4. [Blog page](#blog-page)
5. [GitHub Pages](#github-pages)
6. [Development instructions](#development)

### Installation

The easiest solution is to [fork this repo](https://github.com/eliottvincent/bay/fork).
If you want to start from a clean website, follow the steps below:

Create a new Jekyll website:
```
jekyll new mysite
```

Open `Gemfile` and replace the line:
```
gem "minima"
```
with:
```
gem "bay_jekyll_theme"
```

Open `_config.yml` and replace the line:
```
theme: minima
```
with:
```
theme: bay_jekyll_theme
```
or, for GitHub Pages:
```
remote_theme: eliottvincent/bay
```

Finally, install the dependencies:
```
bundle install
```

and build the website!
```
jekyll serve
```

The website will look somewhat empty at first. That's normal. Follow the next instructions to complete the header and footer components, and the home and blog pages.

#### Header

Open the `_config.yml` file and add the following:
```yml
header:
  pages:
    - name: Home
      slug: /     # <-- index.md
    - name: Blog  # <-- blog.md
    - name: Whatever  # <-- whatever.md
```
Re-run `jekyll serve` to see the header updated.

#### Footer

Open the `_config.yml` file and add the following:
```yml
footer:
  show_powered_by: true
  contact:
    - type: email
      name: Email
      value: yourmail@domain.com
    - type: wechat
      value: YourWeChatUsername
      link: "#"
  follow:
    - type: twitter
      name: Twitter
      link: http://twitter.com/YourTwitterUsername
      username: "@YourTwitterUsername"
    - type: facebook
      name: Facebook
      link: http://facebook.com/YourFacebookUsername
    - type: linkedin
      name: LinkedIn
      link: http://linkedin.com/in/YourLinkedInUsername
    - type: github
      name: GitHub
      link: http://github.com/YourGitHubUsername
    - type: dribbble
      name: Dribbble
      link: https://dribbble.com/YourDribbbleUsername
    - type: rss
      name: RSS
      link: /feed.xml
```
Re-run `jekyll serve` to see the footer updated.

#### Home page

Create (or edit) the `index.markdown` file and add the following:
```yml
---
layout: home
profile_picture:
  src: /assets/img/profile-pic.jpg
  alt: website picture
---

<p>
  Welcome to my site!
</p>
```

#### Blog page

```yml
Create `blog.markdown` file and add the following:
---
layout: blog
title: Blog
slug: /blog
---

This is an example of a "Blog" page, displaying a list of posts.
<br />
```

Your website is ready!

### GitHub Pages

You can deploy your website to GitHub Pages, but you cannot use the 1-click GitHub Pages build-and-deploy system. The issue is that the Bay theme relies on Jekyll 4.3+ (which uses a more modern Sass processor), whereas the GitHub Pages build system uses an older version of Jekyll.

However, it's fairly easy to build and deploy your website with GitHub Actions, yet use GitHub Pages to host it.

Further explanations and instructions can be found on the official [Jekyll website](https://jekyllrb.com/docs/continuous-integration/github-actions/).

You can also refer to the [`.github/workflows/deploy.yml`](https://github.com/eliottvincent/bay/blob/master/.github/workflows/deploy.yml) file in this repository.

### Development

#### Run development instance (with hot-reload)

```sh
bundle exec jekyll serve
```

#### Build and publish the gem

Simply push and tag a new version, Github Actions will handle the rest.