README.md in jekyll-agency-1.0.9 vs README.md in jekyll-agency-1.1.0
- old
+ new
@@ -1,87 +1,116 @@
-<!--[Creating Gem Based Themes For Jekyll](https://www.chrisanthropic.com/blog/2016/creating-gem-based-themes-for-jekyll/)-->
-
-# [Agency Jekyll Theme](https://raviriley.github.io/agency-jekyll-theme) - Work in Progress
-
+# [Agency Jekyll Theme](https://raviriley.github.io/agency-jekyll-theme)
+[](https://rubygems.org/gems/jekyll-agency)
[](https://github.com/raviriley/agency-jekyll-theme/blob/master/LICENSE.txt)
[](https://www.paypal.me/raviriley)
-[](https://rubygems.org/gems/jekyll-agency)
+[](https://github.com/raviriley/agency-jekyll-theme-starter/generate)
+<!--[](https://jekyll-themes.com)-->
-This is the [Agency Bootstrap theme](https://startbootstrap.com/themes/agency/) converted to a gem-based Jekyll theme. 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:
+
+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 text)
+- logo support (instead of just title text)
- automatically updating copyright years
- custom navigation bar, even without the header image(s)
-- about section (different from the timeline)
-- custom footer
-<!-- - portfolio carousel (coming soon) -->
+- customizable footer
+- custom accent color and dark/light colors
+- horizontal scrolling support for client section
+<!--
- custom colors with automatic gradient generation (coming soon)
- site title logo text font customization (coming soon)
+- horizontal scrolling support for portfolio section (coming soon)
+- about section (different from the timeline) -->
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 and background images
+- `navigation.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"
```
-And add this line to your Jekyll site's `_config.yml`:
+Then, replace the contents of your `_config.yml` file with [this](https://github.com/raviriley/agency-jekyll-theme/blob/master/_config.yml).
-```yaml
-theme: jekyll-agency
-```
-
And then execute:
$ bundle
-Or install it yourself as:
+Or, install it yourself as:
$ gem install jekyll-agency
-Then, replace the contents of your `_config.yml` file with [this](https://github.com/raviriley/agency-jekyll-theme/blob/master/_config.yml).
+#### 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 the button below, then replace the sample content with your own and configure for your needs.
-## Usage
+[](https://github.com/raviriley/agency-jekyll-theme-starter/generate)
-<!--TODO: Write usage instructions here. Describe your available layouts, includes, sass and/or assets.-->
+#### 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
+
+<!--
+## Documentation and Usage
+
+**TODO:** Write usage instructions here. Describe available layouts, includes, or assets.
+
navheader is used only for the home page. nav is used everywhere else.
+Layouts:
+
+Includes:
+
+-->
+
## 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
+- customizable background coloring for each section
+- ~~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.
+To set up your environment to develop this theme, [clone this repo](https://github.com/raviriley/agency-jekyll-theme.git), 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.
## License
The theme is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).