simplify YAML params and readme
This commit is contained in:
Dean Attali
parent
6ba0d82cc5
commit
757206b082
23
README.md
23
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
|
||||
|
||||
|
|
|
|||
14
_config.yml
14
_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
|
||||
|
|
|
|||
|
|
@ -3,12 +3,12 @@
|
|||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0">
|
||||
|
||||
<title>{% if page.title %}{{ page.title }}{% else %}{{ site.name }}{% endif %}</title>
|
||||
<title>{% if page.title %}{{ page.title }}{% else %}{{ site.title }}{% endif %}</title>
|
||||
|
||||
<meta name="author" content="{{ site.author.name }}" />
|
||||
<meta name="description" content="{{ site.description }}">
|
||||
|
||||
<link rel="alternate" type="application/rss+xml" title="{{ site.name }} - {{ site.description }}" href="{{ site.baseurl }}/feed.xml" />
|
||||
<link rel="alternate" type="application/rss+xml" title="{{ site.title }} - {{ site.description }}" href="{{ site.baseurl }}/feed.xml" />
|
||||
|
||||
{% if page.common-ext-css %}
|
||||
{% for css in page.common-ext-css %}
|
||||
|
|
|
|||
|
|
@ -8,9 +8,9 @@ layout: default
|
|||
<div class="col-lg-8 col-lg-offset-2 col-md-10 col-md-offset-1">
|
||||
<div class="page-heading">
|
||||
<h1>{{ page.title }}</h1>
|
||||
{% if page.description %}
|
||||
{% if page.subtitle %}
|
||||
<hr class="small">
|
||||
<span class="page-subheading">{{ page.description }}</span>
|
||||
<span class="page-subheading">{{ page.subtitle }}</span>
|
||||
{% endif %}
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -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:
|
||||
|
|
|
|||
2
feed.xml
2
feed.xml
|
|
@ -4,7 +4,7 @@ layout: null
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom">
|
||||
<channel>
|
||||
<title>{{ site.name | xml_escape }}</title>
|
||||
<title>{{ site.title | xml_escape }}</title>
|
||||
<description>{{ site.description | xml_escape }}</description>
|
||||
<link>{{ site.url }}</link>
|
||||
<atom:link href="{{ site.url }}/feed.xml" rel="self" type="application/rss+xml" />
|
||||
|
|
|
|||
|
|
@ -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
|
||||
---
|
||||
|
||||
<div class="main-explain-area jumbotron">
|
||||
|
|
|
|||
Loading…
Reference in New Issue