updated readme

This commit is contained in:
Panos Sakkos 2015-07-05 03:11:18 +02:00
parent ed3ab8623e
commit 2558ed24a6

View file

@ -27,31 +27,33 @@
* Timeline events
* Disqus comments
# Screenshots
## Index page
![Index page](https://dl.dropboxusercontent.com/u/8522559/personal-jekyll-theme/index.jpg)
## Latest post preview
![Blog](https://dl.dropboxusercontent.com/u/8522559/personal-jekyll-theme/blog.jpg)
## Timeline
![Career](https://dl.dropboxusercontent.com/u/8522559/personal-jekyll-theme/career.jpg)
## Blog Archive
![Archive](https://dl.dropboxusercontent.com/u/8522559/personal-jekyll-theme/archive.jpg)
## Post page
![Post](https://dl.dropboxusercontent.com/u/8522559/personal-jekyll-theme/post.jpg)
## Customizing your website from the config
Even if you have no experience with Jekyll you can personalize your website from the config file (_config.yml). This section describes the variables and how they change the content of your website.
Even if you have no experience with Jekyll you can personalize your website from the config file (_config.yml). This section describes the available variables and how they change the content of your website.
### Favicon
````
favicon: "/img/favicon.ico"
````
Points to the website's favicon. You can either change the path to the desired favicon or replace the actual file.
Points to the website's favicon.
### Black Favicon
````
black-favicon: "/img/black-lab-glass.ico"
````
Before the title of website a black and white version of the favicon appears. This value is the path to this image file.
Before the title of the website a black and white version of the favicon appears. This value is the path to this icon file.
### Google Analytics
````
@ -63,10 +65,10 @@ Place the id of your tracking code here and the code will be autogenerated and i
````
disqus-shortname: "panossakkos"
````
Add your Disqus username to enable Disqus comments. When this value is set then every post will get the comments below the post and the comments counters in the post preview of the home page and the Archive. Remove the value if you don't want the Disqus functionality.
Add your Disqus username to enable Disqus comments. When this value is set then, every post will get the comments below the post and the comment counters in the post preview of the home page and the Archive. Remove the value if you don't want the Disqus functionality.
### Navigation Bar links
This variable is usefull only if you want to add more pages and not be included in the navigation bar. It included the pages that you want to include in the navigation bar.
This variable is usefull only if you want to add more pages and not be included in the navigation bar. It contains the pages that you want to include in the navigation bar.
````
pages_list:
About: 'about'
@ -93,12 +95,54 @@ This variable dicates how many words do you want to display as preview in the Bl
post-preview-words: 128
````
For all the variables that contain image paths, you can either change them to point to the new images, or replace the image files.
### Timeline Events
The Timeline is displayed in the Career section of the homepage. Each event consists of a date (when did the event started and ended), an image and a description.
````
events:
- image: "/img/career/microsoft.jpg"
date: "September 2014 - Today"
description: "Software Engineer @ Microsoft Development Center Norway, working @ the <a href=\"http://dev.office.com/officegraph\" target=\"_blank\"> Office Graph</a>"
- image: "/img/career/uoa.jpg"
date: "October 2012 - August 2014"
description: "Master studies @ <a href=\"http://www.di.uoa.gr/eng\" target=\"_blank\">Department of Informatics and Telecommunications</a> on Software Engineering + <a href=\"https://scholar.google.com/citations?user=UtV6LFYAAAAJ&amp;hl=en&amp;oi=ao\" target=\"_blank\">Machine Learning researcher</a> @ <a href=\"http://kddlab.di.uoa.gr\" target=\"_blank\">KDD</a> lab"
- image: "/img/career/cern.jpg"
date: "October 2011 - September 2012"
description: "Security researcher @ <a href=\"http://www.cern.ch\" target=\"_blank\">CERN</a>, developed linux kernel extensions to prevent cyber attacks"
- image: "/img/career/writeright.jpg"
date: "August 2011 - Today"
description: "Released <a href=\"https://play.google.com/store/apps/details?id=panos.sakkos.softkeyboard.writeright\" target=\"_blank\">WriteRight</a>, an adaptive S/W keyboard for Android devices, which shrinks the unlikely keys to tap next. Currently it holds &gt; 9,000 downloads"
- image: "/img/career/pwnmail.jpg"
date: "June 2010 - November 2010"
description: "Released <a href=\"https://www.google.com/search?q=pwn+mail\" target=\"_blank\">Pwn Mail</a>, an iPhone app for spoofing emails. It served &gt; 260,000 emails but it was discontinued after a legal threat by <strike>Steve Jobs</strike> a secretary of Steve Jobs"
- image: "/img/career/uoa.jpg"
date: "October 2007 - September 2011"
description: "Bachelor studies @ <a href=\"http://www.di.uoa.gr/eng\" target=\"_blank\">Department of Informatics and Telecommunications</a> on Computer Science and Telecomunications"
````
After the Timeline you get a picture which you can set it from the career-img variable
````
career-img: "/img/career/default.jpg"
````
### Social Networks buttons
As a footer you get a list of buttons which are links to various social networks. You can specify the buttons and links form the social variable:
````
social:
- title: "rss"
url: "/feed.xml"
- title: "github"
url: "https://github.com/PanosSakkos"
- title: "linkedin"
url: "https://no.linkedin.com/in/PanosSakkos"
- title: "youtube"
url: "https://youtube.com/c/PanosSakkos"
- title: "soundcloud"
url: "https://soundcloud.com/psakkos/"
````
There are many more social networks supported like facebook, flickr, dribbble, pinterest, instagram, tumblr etc.
## Posting a new post
Jekyll is waiting for new posts to show up as a file under _/posts with a file name "YYYY-MM-DD-title.markup". Also your file's content should start like this:
Jekyll is expecting new posts to show up as a file under _/posts with a file name "YYYY-MM-DD-title.markup". Also your file's content should start like this:
```
---
layout: post
@ -106,9 +150,8 @@ title: <Post's title>
category: <Post's category>
---
```
After this header you can start writing your post using Markdown.
## Steps forward
* Support discovery with support of tags
* 404 page
* Add 404 page