Update documentation

README.md

@@ -10,13 +10,13 @@ A basic but extensible Jekyll theme based on Bootstrap 5.
 
 ### Gemfile
 
-Add this line to your Jekyll site's `Gemfile`:
+Add this line to your `Gemfile`:
 
 ```ruby
-gem "jekyll-bootstrap-theme"
+gem 'jekyll-bootstrap-theme', '~> 0'
 ```
 
-And add this line to your Jekyll site's `_config.yml`:
+And add this line to your site's `_config.yml`:
 
 ```yaml
 theme: jekyll-bootstrap-theme
@@ -52,7 +52,7 @@ remote_theme: jonaharagon/jekyll-bootstrap-theme
 Optionally, you can specify a [release](https://github.com/jonaharagon/jekyll-bootstrap-theme/releases), [branch](https://github.com/jonaharagon/jekyll-bootstrap-theme/branches), or [tag](https://github.com/jonaharagon/jekyll-bootstrap-theme/tags) to lock the theme version in place:
 
 ```yaml
-remote_theme: jonaharagon/jekyll-bootstrap-theme@v5.0.0-beta3
+remote_theme: jonaharagon/jekyll-bootstrap-theme@v1.0.0
 ```
 
 ## Theme Contents

_includes/footer.html

@@ -24,10 +24,12 @@
         <p>{{ site.description | escape }}</p>
       </div>
     </div>
+    {%- if site.bootstrap.social_links -%}
     <div class="row py-3">
       <div class="col">
         {%- include social.html -%}
       </div>
     </div>
+    {%- endif -%}
   </div>
 </footer>

_includes/social.html

@@ -1,16 +1,16 @@
 {%- assign social = site.bootstrap.social_links -%}
 
 <ul class="text-center list-inline">
-  {%- if true or social.facebook -%}<li class="list-inline-item"><a rel="me" class="link-secondary" href="{{ social.facebook }}"><i class="bi bi-facebook" role="img" aria-label="Facebook"></i></a></li>{%- endif -%}
-  {%- if true or social.github -%}<li class="list-inline-item"><a rel="me" class="link-secondary" href="{{ social.github }}"><i class="bi bi-github"role="img" aria-label="GitHub"></i></a></li>{%- endif -%}
-  {%- if true or social.instagram -%}<li class="list-inline-item"><a rel="me" class="link-secondary" href="{{ social.instagram }}"><i class="bi bi-instagram"role="img" aria-label="Instagram"></i></a></li>{%- endif -%}
-  {%- if true or social.linkedin -%}<li class="list-inline-item"><a rel="me" class="link-secondary" href="{{ social.linkedin }}"><i class="bi bi-linkedin"role="img" aria-label="LinkedIn"></i></a></li>{%- endif -%}
-  {%- if true or social.twitter -%}<li class="list-inline-item"><a rel="me" class="link-secondary" href="{{ social.twitter }}"><i class="bi bi-twitter"role="img" aria-label="Twitter"></i></a></li>{%- endif -%}
-  {%- if true or social.google -%}<li class="list-inline-item"><a rel="me" class="link-secondary" href="{{ social.google }}"><i class="bi bi-google"role="img" aria-label="Google"></i></a></li>{%- endif -%}
-  {%- if true or social.youtube -%}<li class="list-inline-item"><a rel="me" class="link-secondary" href="{{ social.youtube }}"><i class="bi bi-youtube"role="img" aria-label="YouTube"></i></a></li>{%- endif -%}
-  {%- if true or social.twitch -%}<li class="list-inline-item"><a rel="me" class="link-secondary" href="{{ social.twitch }}"><i class="bi bi-twitch"role="img" aria-label="Twitch"></i></a></li>{%- endif -%}
-  {%- if true or social.telegram -%}<li class="list-inline-item"><a rel="me" class="link-secondary" href="{{ social.telegram }}"><i class="bi bi-telegram"role="img" aria-label="Telegram"></i></a></li>{%- endif -%}
-  {%- if true or social.whatsapp -%}<li class="list-inline-item"><a rel="me" class="link-secondary" href="{{ social.whatsapp }}"><i class="bi bi-whatsapp"role="img" aria-label="WhatsApp"></i></a></li>{%- endif -%}
-  {%- if true or social.discord -%}<li class="list-inline-item"><a rel="me" class="link-secondary" href="{{ social.discord }}"><i class="bi bi-discord"role="img" aria-label="Discord"></i></a></li>{%- endif -%}
-  {%- if true or social.slack -%}<li class="list-inline-item"><a rel="me" class="link-secondary" href="{{ social.slack }}"><i class="bi bi-slack"role="img" aria-label="Slack"></i></a></li>{%- endif -%}
+  {%- if social.facebook -%}<li class="list-inline-item"><a rel="me" class="link-secondary" href="{{ social.facebook }}"><i class="bi bi-facebook" role="img" aria-label="Facebook"></i></a></li>{%- endif -%}
+  {%- if social.github -%}<li class="list-inline-item"><a rel="me" class="link-secondary" href="{{ social.github }}"><i class="bi bi-github"role="img" aria-label="GitHub"></i></a></li>{%- endif -%}
+  {%- if social.instagram -%}<li class="list-inline-item"><a rel="me" class="link-secondary" href="{{ social.instagram }}"><i class="bi bi-instagram"role="img" aria-label="Instagram"></i></a></li>{%- endif -%}
+  {%- if social.linkedin -%}<li class="list-inline-item"><a rel="me" class="link-secondary" href="{{ social.linkedin }}"><i class="bi bi-linkedin"role="img" aria-label="LinkedIn"></i></a></li>{%- endif -%}
+  {%- if social.twitter -%}<li class="list-inline-item"><a rel="me" class="link-secondary" href="{{ social.twitter }}"><i class="bi bi-twitter"role="img" aria-label="Twitter"></i></a></li>{%- endif -%}
+  {%- if social.google -%}<li class="list-inline-item"><a rel="me" class="link-secondary" href="{{ social.google }}"><i class="bi bi-google"role="img" aria-label="Google"></i></a></li>{%- endif -%}
+  {%- if social.youtube -%}<li class="list-inline-item"><a rel="me" class="link-secondary" href="{{ social.youtube }}"><i class="bi bi-youtube"role="img" aria-label="YouTube"></i></a></li>{%- endif -%}
+  {%- if social.twitch -%}<li class="list-inline-item"><a rel="me" class="link-secondary" href="{{ social.twitch }}"><i class="bi bi-twitch"role="img" aria-label="Twitch"></i></a></li>{%- endif -%}
+  {%- if social.telegram -%}<li class="list-inline-item"><a rel="me" class="link-secondary" href="{{ social.telegram }}"><i class="bi bi-telegram"role="img" aria-label="Telegram"></i></a></li>{%- endif -%}
+  {%- if social.whatsapp -%}<li class="list-inline-item"><a rel="me" class="link-secondary" href="{{ social.whatsapp }}"><i class="bi bi-whatsapp"role="img" aria-label="WhatsApp"></i></a></li>{%- endif -%}
+  {%- if social.discord -%}<li class="list-inline-item"><a rel="me" class="link-secondary" href="{{ social.discord }}"><i class="bi bi-discord"role="img" aria-label="Discord"></i></a></li>{%- endif -%}
+  {%- if social.slack -%}<li class="list-inline-item"><a rel="me" class="link-secondary" href="{{ social.slack }}"><i class="bi bi-slack"role="img" aria-label="Slack"></i></a></li>{%- endif -%}
 </ul>

jekyll-bootstrap-theme.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name          = "jekyll-bootstrap-theme"
-  spec.version       = "5.0.0.beta3"
+  spec.version       = "0.1.0"
   spec.authors       = ["Jonah Aragon"]
   spec.email         = ["jonah@triplebit.net"]