From 757206b08202d85fc8f450384742335ffe974111 Mon Sep 17 00:00:00 2001 From: Dean Attali Date: Tue, 3 Mar 2015 01:03:01 -0800 Subject: [PATCH] simplify YAML params and readme --- README.md | 23 +++++++++++------------ _config.yml | 14 ++++++-------- _includes/head.html | 4 ++-- _layouts/page.html | 4 ++-- aboutme.md | 2 +- feed.xml | 2 +- index.html | 2 +- 7 files changed, 24 insertions(+), 27 deletions(-) diff --git a/README.md b/README.md index 23a075b..b59484d 100644 --- a/README.md +++ b/README.md @@ -68,18 +68,17 @@ Many personalization settings in `_config.yml`, such as setting your avatar to a There are all the parameters you can place inside a page's YAML front matter that **Beautiful Jekyll** supports. -Parameter | Page types supported | Description -------------| -------------------- | ----------- -layout | all | What type of page this is -title | all | Page title -subtitle | post | Short subtitle -description | page | Short description of page -date | minimal | Date to show in the mini footer -js | all | List of local JavaScript files to include in the page (eg. `/js/mypage.js`) -ext-js | all | List of external JavaScript files to include in the page (eg. `//cdnjs.cloudflare.com/ajax/libs/underscore.js/1.8.2/underscore-min.js`) -css | all | List of local CSS files to include in the page -ex-css | all | List of external CSS files to include in the page -googlefonts | all | List of Google fonts to include in the page (eg. `["Monoton", "Lobster"]`) +Parameter | Description +----------- | ----------- +layout | What type of page this is (recommended options are `page`, `post`, or `minimal`) +title | Page or blog post title +subtitle | Short description of page or blog post +keywords | Comma-separated list of keywords for the current page (eg. "soccer, sports, barcelona, messi") +js | List of local JavaScript files to include in the page (eg. `/js/mypage.js`) +ext-js | List of external JavaScript files to include in the page (eg. `//cdnjs.cloudflare.com/ajax/libs/underscore.js/1.8.2/underscore-min.js`) +css | List of local CSS files to include in the page +ex-css | List of external CSS files to include in the page +googlefonts | List of Google fonts to include in the page (eg. `["Monoton", "Lobster"]`) ### Project page vs user page diff --git a/_config.yml b/_config.yml index 0716cc5..51924fe 100644 --- a/_config.yml +++ b/_config.yml @@ -13,15 +13,18 @@ baseurl: "" # Of course don't forget to change the username and projectname to YOUR username and project +# Name of website +title: My website + +# Short description of your site +description: A virtual proof that name is awesome! + # --- Navigation bar options --- # # 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" -# Name of website to show in the navigation bar -title: My website - # List of links in the navigation bar navbar-links: Home: "" @@ -55,11 +58,6 @@ footer-links-active: # Remove this if you don't want a link in the footer url-pretty: "MyWebsite.com" # eg. "deanattali.com/beautiful-jekyll" -# --- Header meta --- # -# Brief name and description of the site -name: name's website -description: A virtual proof that name is awesome! - # --- Misc --- # # Fill in your Disqus shortname (NOT the userid) if you want to support Disqus comments diff --git a/_includes/head.html b/_includes/head.html index 8981dd8..7bb7d8b 100644 --- a/_includes/head.html +++ b/_includes/head.html @@ -3,12 +3,12 @@ - {% if page.title %}{{ page.title }}{% else %}{{ site.name }}{% endif %} + {% if page.title %}{{ page.title }}{% else %}{{ site.title }}{% endif %} - + {% if page.common-ext-css %} {% for css in page.common-ext-css %} diff --git a/_layouts/page.html b/_layouts/page.html index 773054f..5b9a3f1 100644 --- a/_layouts/page.html +++ b/_layouts/page.html @@ -8,9 +8,9 @@ layout: default

{{ page.title }}

- {% if page.description %} + {% if page.subtitle %}
- {{ page.description }} + {{ page.subtitle }} {% endif %}
diff --git a/aboutme.md b/aboutme.md index ddcc0a2..2347809 100644 --- a/aboutme.md +++ b/aboutme.md @@ -1,7 +1,7 @@ --- layout: page title: About me -description: Why you'd want to go on a date with me +subtitle: Why you'd want to go on a date with me --- My name is Inigo Montoya. I have the following qualities: diff --git a/feed.xml b/feed.xml index cd2321b..75880a3 100644 --- a/feed.xml +++ b/feed.xml @@ -4,7 +4,7 @@ layout: null - {{ site.name | xml_escape }} + {{ site.title | xml_escape }} {{ site.description | xml_escape }} {{ site.url }} diff --git a/index.html b/index.html index 754a5e2..37a9ad8 100644 --- a/index.html +++ b/index.html @@ -1,7 +1,7 @@ --- layout: page title: My website -description: This is where I will tell my friends way too much about me +subtitle: This is where I will tell my friends way too much about me ---