updated documentation post

This commit is contained in:
Panos Sakkos 2015-11-23 23:50:40 +01:00
parent 699e1a7e0c
commit d5f6d4d4cf
3 changed files with 10 additions and 9 deletions

View file

@ -10,7 +10,8 @@ A website is truly personal if it's your blog as well, this place of the interne
### Latest post preview in Index page
First of all, you get a preview of the latest post in the index, in order to attract the visitor to visit your blog. The size of this preview is defined by:
First of all, you get a preview of the latest post in the index, in order to attract the visitor to visit your blog.
The size of this preview is defined by:
<pre><code data-trim class="yaml">
post-preview-words: 96

View file

@ -15,7 +15,7 @@ The intro part of the index page (Header) is consisted of four elements:
<li>Your image</li>
</ol>
## Black favicon
### Black favicon
The black favicon is an image on the left of the navigation bar.
Preferably it should be a black and white version of your favicon.
@ -24,7 +24,7 @@ Preferably it should be a black and white version of your favicon.
black-favicon: "/img/black-lab-glass.ico"
</code></pre>
## Background image
### Background image
In order to set the background, set the path to following variable:
@ -34,7 +34,7 @@ background-img: "../img/intro-bg.jpg"
<small>NB! Keep the .. in the beginning of the background image path</small>
## Welcome text
### Welcome text
The welcome text is controlled by the following (self-explanatory) variables:
@ -55,7 +55,7 @@ lines: # You can add HTML Tags in the Text
- text: "Wheres your will to be weird?"
</code></pre>
## Your image
### Your image
You can set your image from the following variable:

View file

@ -10,7 +10,7 @@ All features of { Personal } are controlled by setting values to variables that
\_config.yml file. Let's start with the initial variables that you have to set before
serving your { Personal } website for the first time.
## Essential variables
### Essential variables
<pre><code data-trim class="yaml">
# NB! Set your site's url, otherwise stuff will break :)
@ -35,7 +35,7 @@ The url and baseurl variables are essential to be set, because they are used *ev
The Google tracking code will be placed in every generated page.
If you don't want Google tracking, set it to an empty string.
## HTTPS
### HTTPS
By default { Personal } will enforce https by javascript redirection.
HTTPS is important because it encrypts the data sent between the client and the server.
@ -53,7 +53,7 @@ variable to False:
force-https: True
</code></pre>
## HTML Head
### HTML Head
<pre><code data-trim class="yaml">
#############
@ -70,7 +70,7 @@ keywords: "smith, jones, personal, jekyll, theme"
The values that you set, will be placed in the head section of every generated HTML page.
## Serving { Personal }
### Serving { Personal }
Install the required dependencies: