Updated documentation.
This commit is contained in:
parent
ad5a3709fb
commit
3097117dea
8 changed files with 20 additions and 30 deletions
|
|
@ -14,8 +14,8 @@ The contact part of the index page is consisted of two elements:
|
|||
</ol>
|
||||
|
||||
You can modify its text from the contact.html file.
|
||||
Then in the _config.yml set the email variable to your email.
|
||||
Then in the \_config.yml set the email variable to your email.
|
||||
|
||||
Don't be afraid of Email Harvesting, write your email properly, and the page will perform javascript obfuscation.
|
||||
|
||||
<small>Many thanks to <a href="https://github.com/joariasl" target="_blank">@joariasl</a> for this feature!</small>
|
||||
<small>Many thanks to <a href="https://github.com/joariasl" target="blank">@joariasl</a> for this feature!</small>
|
||||
|
|
|
|||
|
|
@ -7,14 +7,14 @@ tags: [ 'tutorial' ]
|
|||
---
|
||||
|
||||
Social buttons (rendered in the footer) are great for having a small hub with all your social footprint.
|
||||
In order to change them, go to _config.yml and edit the social list:
|
||||
In order to change them, jump to \_config.yml and edit the social list:
|
||||
|
||||
<pre style="text-align: left">
|
||||
social:
|
||||
- title: "github"
|
||||
url: "https://github.com/"
|
||||
- title: "linkedin"
|
||||
url: "http://no.linkedin.com/"
|
||||
url: "http://linkedin.com/"
|
||||
- title: "youtube"
|
||||
url: "http://youtube.com/"
|
||||
- title: "rss"
|
||||
|
|
@ -24,4 +24,3 @@ social:
|
|||
The titles of the social link are used to find the icon in Font Awesome.
|
||||
|
||||
To look for an icon, search for one at the [Font Awesome icon gallery](https://fortawesome.github.io/Font-Awesome/icons/) and put the icon name (without fa-) as title.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,14 +1,14 @@
|
|||
---
|
||||
layout: post
|
||||
section-type: post
|
||||
title: Adding a life event
|
||||
title: Adding a life event in the Timeline
|
||||
category: tech
|
||||
tags: [ 'tutorial' ]
|
||||
---
|
||||
One of the cool features of { Personal } is that enables you to tell your life's story in
|
||||
One of the coolest features of { Personal } is that enables you to tell your life's story in
|
||||
the form of a timeline of photos, dates and text descriptions. Let's see how it works.
|
||||
|
||||
Open the _config.yml and find the events list definition, it should look like this:
|
||||
Open the \_config.yml and find the events list definition, it should look like this:
|
||||
|
||||
<pre style="text-align: left">
|
||||
events:
|
||||
|
|
|
|||
|
|
@ -9,11 +9,11 @@ tags: [ 'tutorial' ]
|
|||
Run the ./scripts/newpost script with the file name of the post as an argument:
|
||||
|
||||
<pre style="text-align: left">
|
||||
cd <your { personal } repo>
|
||||
cd <your { Personal } repo>
|
||||
./scripts/newpost hello-world
|
||||
</pre>
|
||||
|
||||
A a new post template with name YYYY-MM-DD-hello-world.md will be created under ./_posts, with the current date.
|
||||
A a new post template with name YYYY-MM-DD-hello-world.md will be created under ./\_posts, with the current date.
|
||||
|
||||
In the created post, just replace the Title, Category and tags and you can
|
||||
start writing your post in markdown right bellow the end of the post header.
|
||||
|
|
|
|||
|
|
@ -11,7 +11,7 @@ A website is truly personal if it's your blog as well, this place of the interne
|
|||
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 style="text-align: left">
|
||||
post-preview-words: 128
|
||||
post-preview-words: 96
|
||||
</pre>
|
||||
|
||||
Feel free to experiment with different sizes, and pick the best for you.
|
||||
|
|
@ -24,14 +24,6 @@ order. You can define the number of posts that are displayed per page by changin
|
|||
paginate: 5
|
||||
</pre>
|
||||
|
||||
You can select the social network share buttons that you want under each post from:
|
||||
|
||||
<pre style="text-align: left">
|
||||
fb-share: True
|
||||
twitter-share: True
|
||||
reddit-share: True
|
||||
</pre>
|
||||
|
||||
Facebook, Twitter, Reddit, LinkedIn, Google+, Pinterest, VKontakte share buttons are available which can be enabled or disabled by setting the following:
|
||||
|
||||
<pre style="text-align: left">
|
||||
|
|
@ -44,8 +36,7 @@ pinterest-share: True
|
|||
vkontakte-share: True
|
||||
</pre>
|
||||
|
||||
And you can enable <a href="http://www.disqus.com" target="_blank">Disqus</a> comments
|
||||
by just setting your Disqus username here:
|
||||
And you can enable <a href="http://www.disqus.com" target="blank">Disqus</a> comments by just setting your Disqus username here:
|
||||
|
||||
<pre style="text-align: left">
|
||||
disqus-shortname: "<YOUR DISQUS USERNAME>"
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@ category: tech
|
|||
tags: [ 'tutorial' ]
|
||||
---
|
||||
|
||||
The intro part of the index page is consisted of three elements:
|
||||
The intro part of the index page is consisted of four elements:
|
||||
|
||||
<ol>
|
||||
<li>A black favicon</li>
|
||||
|
|
@ -38,9 +38,9 @@ lines: # You can add HTML Tags in the Text
|
|||
- text: "Where’s your will to be weird?"
|
||||
</pre>
|
||||
|
||||
<small>Many thanks to <a href="https://github.com/prashantsolanki3" target="_blank">@prashantsolanki3</a> for this feature!</small>
|
||||
<small>Many thanks to <a href="https://github.com/prashantsolanki3" target="blank">@prashantsolanki3</a> for this feature!</small>
|
||||
|
||||
In order to set the background and your image, modify the following variables in _config:
|
||||
In order to set the background and your image, modify the following variables in \_config:
|
||||
|
||||
<pre style="text-align: left">
|
||||
black-favicon: "/img/black-lab-glass.ico"
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@ category: tech
|
|||
tags: [ 'tutorial' ]
|
||||
---
|
||||
|
||||
In the _config.yml, find and set the variables of the Head section:
|
||||
In the \_config.yml, find and set the variables of the Head section:
|
||||
|
||||
<pre style="text-align: left">
|
||||
#############
|
||||
|
|
@ -37,10 +37,10 @@ If you don't want Google tracking, set it to an empty string, or simply remove t
|
|||
|
||||
If you are using *{ Personal }* as a Github repository theme, set the repository name as the site.baseurl, in the site configuration file.
|
||||
This step is essential, since its related to file paths!
|
||||
And when you serve the website locally, don't forget to set the baseurl to an empty string, like this:
|
||||
In order to serve the website locally just run:
|
||||
|
||||
<pre style="text-align: left">
|
||||
jekyll serve --baseurl ""
|
||||
./scripts/serve
|
||||
</pre>
|
||||
|
||||
<small>Many thanks to <a href="https://github.com/prashantsolanki3" target="_blank">@prashantsolanki3</a> for the language support!</small>
|
||||
<small>Many thanks to <a href="https://github.com/joariasl" target="blank">@joariasl</a> for the language support! </small>
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ tags: [ 'tutorial' ]
|
|||
|
||||
Click the view more posts link bellow, to see the currently available post-tutorials to help you get your { Personal } website up and running quicker!
|
||||
|
||||
Note that every time you update the site configuration (_config.yml), you will need
|
||||
Note that every time you update the site configuration (\_config.yml), you will need
|
||||
to cancel the serving (*Ctr + C*) and serve the website again.
|
||||
|
||||
Any contributions, feedback and issues to the <a href="https://github.com/PanosSakkos/personal-jekyll-theme" target="_blank">repo</a> are more than welcome!
|
||||
Any contributions, feedback or issues to the <a href="https://github.com/PanosSakkos/personal-jekyll-theme" target="blank">repo</a> are more than welcome!
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue