README.md in jekyll-agency-1.0.7 vs README.md in jekyll-agency-1.0.8
- old
+ new
@@ -1,32 +1,35 @@
-[Creating Gem Based Themes For Jekyll](https://www.chrisanthropic.com/blog/2016/creating-gem-based-themes-for-jekyll/)
+<!--[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
[![LICENSE](https://img.shields.io/badge/license-MIT-lightgrey.svg)](https://github.com/raviriley/agency-jekyll-theme/blob/master/LICENSE.txt)
[![Tip Me via PayPal](https://img.shields.io/badge/PayPal-tip%20me-green.svg?logo=paypal)](https://www.paypal.me/raviriley)
+[![RubyGems Downloads](https://img.shields.io/gem/dt/jekyll-agency.svg)](https://rubygems.org/gems/jekyll-agency)
+
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:
+- 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)
- automatically updating copyright years
-- custom navigation bar, even without the header images
-- about section (not the timeline)
+- custom navigation bar, even without the header image(s)
+- about section (different from the timeline)
- custom footer
-- portfolio carousel (coming soon)
+<!-- - portfolio carousel (coming soon) -->
- custom colors with automatic gradient generation (coming soon)
- site title logo text font customization (coming soon)
The Jekyll structure of this theme includes:
-- `_projects` files - what generate the portfolio grid, YAML front matter handles all the details
+- `_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
@@ -59,10 +62,10 @@
Then, replace the contents of your `_config.yml` file with [this](https://github.com/raviriley/agency-jekyll-theme/blob/master/_config.yml).
## Usage
-TODO: Write usage instructions here. Describe your available layouts, includes, sass and/or assets.
+<!--TODO: Write usage instructions here. Describe your available layouts, includes, sass and/or assets.-->
navheader is used only for the home page. nav is used everywhere else.
## Contributing