add documentation and restructure to be simpler

This commit is contained in:
Dean Attali 2015-03-02 14:44:12 -08:00
parent 2494bcdc47
commit 9a2d6f1b3f
3 changed files with 61 additions and 31 deletions

View File

@ -1,32 +1,47 @@
# Serving # --- Serving options --- #
url: "http://daattali.github.io/beautiful-jekyll" # full site URL
url-short: "daattali.github.io/beautiful-jekyll" # how to display the url
baseurl: "/beautiful-jekyll" # does not include hostname
# url is the full website URL
# baseurl is the website's URL without the hostname
# If you are building a simple GitHub user page (<username>.github.io) then use these settings:
#url: "http://<username>.github.io"
#baseurl: ""
# Header meta # If you are building a GitHub project page then use settings similar to mine:
url: "http://daattali.github.io/beautiful-jekyll"
baseurl: "/beautiful-jekyll"
# --- Header meta --- #
# Brief name and description of the site
name: Beautiful Jekyll by Dean Attali name: Beautiful Jekyll by Dean Attali
description: Quickly build a beautiful Jekyll website description: Quickly build a beautiful Jekyll website
# Outputting # --- Outputting options --- #
# More information can be found on Jekyll's site
timezone: "America/Vancouver" timezone: "America/Vancouver"
markdown: redcarpet markdown: redcarpet
highlighter: pygments highlighter: pygments
permalink: /:year-:month-:day-:title permalink: /:year-:month-:day-:title
paginate: 5 paginate: 5
defaults: # --- Navigation bar options --- #
-
scope:
path: "" # all files
values:
layout: "default"
title : Beautiful Jekyll # Image to show in the navigation bar - image must be a square (width = height)
# Remove this parameter if you don't want an image in the navbar
avatar: "/img/avatar-icon.png"
# List of links in the navigation bar
navbar-links:
Home: ""
About Me: "aboutme"
Contact: "contact"
Blog: "blog"
Error page: "nothing"
# --- Footer options --- #
# Change all these values or delete the ones you don't want. # Change all these values or delete the ones you don't want.
# You should keep the "name" parameter since it will be used as the name of blog posts' author. # Important: you must keep the "name" parameter, everything else you can remove
author: author:
name: Dean Attali name: Dean Attali
email: "daattali@gmail.com" email: "daattali@gmail.com"
@ -36,7 +51,7 @@ author:
linkedin: "pub/dean-attali/8/946/143" linkedin: "pub/dean-attali/8/946/143"
stackoverflow: "users/3943160/daattali" stackoverflow: "users/3943160/daattali"
# You can quickly enable/disable links from showing in the footer # Select which links to show in the footer
footer-links-active: footer-links-active:
rss: false rss: false
facebook: true facebook: true
@ -46,18 +61,27 @@ footer-links-active:
linkedin: false linkedin: false
stackoverflow: false stackoverflow: false
avatar: "/img/avatar-icon.png" # image to show in navbar # How to display the link to the website in the footer
# Remove this if you don't want a link in the footer
url-pretty: "deanattali.com/beautiful-jekyll"
# List of links in the navbar # --- Misc --- #
navbar-links:
Home: ""
About Me: "aboutme"
Contact: "contact"
Blog: "blog"
Error page: "nothing"
# disqus: "" # Your disqus shortname # Fill in your Disqus shortname (NOT the userid) if you want to support Disqus comments
# google_analytics: "" # Your Google Analytics ID #disqus: ""
# Fill in your Google Analytics ID to track your website using GA
#google_analytics: ""
# --- Don't need to touch anything below here (but you can if you want) --- #
# Default YAML values (more information on Jekyll's site)
defaults:
-
scope:
path: "" # all files
values:
layout: "default"
# Exclude these files from production site # Exclude these files from production site
exclude: exclude:

View File

@ -7,7 +7,10 @@
{% else %} {% else %}
{{ site.time | date: '%Y' }} {{ site.time | date: '%Y' }}
{% endif %} {% endif %}
{% if site.url-pretty %}
&nbsp;&nbsp;&bull;&nbsp;&nbsp; &nbsp;&nbsp;&bull;&nbsp;&nbsp;
<a href="{{ site.url }}" target="_blank">{{ site.url-short }}</a> <a href="{{ site.url }}">{{ site.url-pretty }}</a>
{% endif %}
</div> </div>
</footer> </footer>

View File

@ -75,11 +75,14 @@
{% endif %} {% endif %}
</ul> </ul>
<p class="copyright text-muted"> <p class="copyright text-muted">
&copy; {{ site.title }} &copy; {{ site.author.name }}
&nbsp;&bull;&nbsp; &nbsp;&bull;&nbsp;
{{ site.time | date: '%Y' }} {{ site.time | date: '%Y' }}
{% if site.url-pretty %}
&nbsp;&bull;&nbsp; &nbsp;&bull;&nbsp;
<a href="{{ site.url }}">{{ site.url-short }}</a> <a href="{{ site.url }}">{{ site.url-pretty }}</a>
{% endif %}
</p> </p>
<p class="theme-by text-muted"> <p class="theme-by text-muted">
Theme by Theme by