forked from mattvh/jekyllthemes
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request mattvh#719 from raviriley/master
Agency Jekyll Theme Submission
- Loading branch information
Showing
2 changed files
with
106 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,106 @@ | ||
| --- | ||
| layout: post | ||
| title: Agency | ||
| date: 2020-06-08 04:20:00 | ||
| homepage: https://github.com/raviriley/agency-jekyll-theme | ||
| download: https://github.com/raviriley/agency-jekyll-theme/archive/master.zip | ||
| demo: https://raviriley.github.io/agency-jekyll-theme-starter/ | ||
| author: Ravi Riley | ||
| thumbnail: agency.PNG | ||
| license: MIT License | ||
| license_link: https://github.com/raviriley/agency-jekyll-theme/blob/master/LICENSE.txt | ||
| --- | ||
|
|
||
| # [Agency Jekyll Theme](https://raviriley.github.io/agency-jekyll-theme) | ||
|
|
||
| [](https://github.com/raviriley/agency-jekyll-theme/blob/master/LICENSE.txt) | ||
| [](https://www.paypal.me/raviriley) | ||
| [](https://rubygems.org/gems/jekyll-agency) | ||
|
|
||
|  | ||
|
|
||
| This is the [Agency Bootstrap theme](https://startbootstrap.com/themes/agency/) converted to a gem-based Jekyll theme with GitHub Pages support. While this had been done before, ([here](https://github.com/y7kim/agency-jekyll-theme), [here](https://github.com/SotiriosVrachas/jekyll-theme-startbootstrap-agency), and [here](https://github.com/laklau/agency-jekyll-theme/)), these are outdated and have not been updated or maintained for years. I built this theme from the most recent Bootstrap source. I also added a lot of new features that go beyond the original theme's capabilities: | ||
|
|
||
| - GitHub Pages support | ||
| - [template repo][template] to get up and running in minutes | ||
| - contact form functionality powered by [Formspree.io](https://formspree.io) | ||
| - custom pages | ||
| - 404 page | ||
| - legal/Privacy Policy page | ||
| - Google Analytics support | ||
| - Markdown support | ||
| - custom images | ||
| - logo support (instead of just title text) | ||
| - automatically updating copyright years | ||
| - custom navigation bar, even without the header image(s) | ||
| - customizable footer | ||
| - custom accent color and dark/light colors | ||
| - horizontal scrolling support for client section | ||
|
|
||
| The Jekyll structure of this theme includes: | ||
|
|
||
| - `_portfolio` files - what generate the portfolio grid. YAML front matter handles all the details | ||
| - the `page` layout allows custom pages, as seen in the legal and 404 pages | ||
| - `sitetext.yml` enables complete customization of all site text | ||
| - `nav.yml` enables fully customizable navigation | ||
| - `style.yml` enables fully customizable colors, background images, and other style-related things | ||
|
|
||
|
|
||
| **If you enjoy this theme, please consider [supporting me](https://www.paypal.me/raviriley) to continue developing and maintaining it.** | ||
|
|
||
| [](https://www.paypal.me/raviriley) | ||
|
|
||
| ## Installation | ||
| There are three ways to install this theme: | ||
| 1. As a gem-based theme | ||
| 2. Use the [starter template][template] (best for GitHub Pages) | ||
| 3. As a remote theme | ||
|
|
||
| #### 1. Gem-based Theme Installation | ||
|
|
||
| Add this line to your Jekyll site's `Gemfile`: | ||
|
|
||
| ```ruby | ||
| gem "jekyll-agency" | ||
| ``` | ||
|
|
||
| Then, replace the contents of your `_config.yml` file with [this](https://github.com/raviriley/agency-jekyll-theme/blob/master/_config.yml). | ||
|
|
||
| And then execute: | ||
|
|
||
| $ bundle | ||
|
|
||
| Or, install it yourself as: | ||
|
|
||
| $ gem install jekyll-agency | ||
|
|
||
| #### 2. Using the [Starter Template][template] | ||
| This is the fastest and easiest way to get up and running on GitHub Pages. | ||
| Simply generate your own repository by clicking [here](https://github.com/raviriley/agency-jekyll-theme-starter/generate), then replace the sample content with your own and configure for your needs. | ||
|
|
||
| #### 3. Remote Theme Installation | ||
|
|
||
| Replace the contents of your `_config.yml` file with [this](https://raw.githubusercontent.com/raviriley/agency-jekyll-theme-starter/master/_config.yml) and your `Gemfile` with [this](https://raw.githubusercontent.com/raviriley/agency-jekyll-theme-starter/master/Gemfile). Then execute: | ||
|
|
||
| $ bundle | ||
|
|
||
| [template]: https://github.com/raviriley/agency-jekyll-theme-starter | ||
|
|
||
|
|
||
| ## Contributing | ||
|
|
||
| This project is intended to be a welcoming space for collaboration. If you have an idea, suggestion, feature request, etc., feel free to open an issue or pull request. | ||
| For bug reports, follow the provided template. | ||
|
|
||
| #### Improvements - Up for Grabs | ||
|
|
||
| - multiple language support | ||
| - ~~custom background images~~ | ||
|
|
||
| ## Development | ||
|
|
||
| To set up your environment to develop this theme, clone this repo, then run `bundle install`. To test the theme, run `bundle exec jekyll serve` and open your browser at `http://localhost:4000`. Add pages, documents, data, etc. like normal to test the theme's contents. As you make modifications, your site will regenerate and you should see the changes in the browser after a refresh, just like normal. | ||
|
|
||
| ## License | ||
|
|
||
| The theme is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT). |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.