sr-rolando/rolandjesse.de
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

updated documentation

Browse source
This commit is contained in:
Panos Sakkos 2015-11-24 00:41:40 +01:00
parent b35df27027
commit 3052477fd0
2 changed files with 17 additions and 18 deletions
Download patch file Download diff file Expand all files Collapse all files

14
README.md
View file

@ -3,8 +3,7 @@
# { Personal } Jekyll Theme
{ Personal } is a free responsive Jekyll theme about you.
It's your personal blog and your point of reference website.
{ Personal } is a free responsive Jekyll theme, about you.
You can watch it in action [here](https://panossakkos.github.io/personal-jekyll-theme/)!
@ -28,12 +27,12 @@ You can watch it in action [here](https://panossakkos.github.io/personal-jekyll-
* Gesture navigation in archive and post pages by swiping
* #tags
* Disqus comments
* Facebook, Twitter, Reddit, LinkedIn, Google+, Pinterest and VKontakte share buttons
* Bootstrap share buttons
* RSS feed
* Cool (anti-procrastinating) 404 page
* Anti-procrastinating 404 page
* iOS and Android Web App mode
* Forcing of https protocol
* Protection from Email harvesting
* Protection from email harvesting
* Sitemap
* Travis CI integration with [html-proofer](https://github.com/gjtorikian/html-proofer)
@ -83,7 +82,7 @@ First you need to install the dependencies:
gem install jekyll jekyll-paginate jemoji html-proofer
````
After installing the dependencies, you can build and serve your website by simply running:
Then, you can build and serve your website by simply running:
````
./scripts/serve-production
@ -95,7 +94,8 @@ Don't forget to list your { Personal } blog in the [Blogs using { Personal }](ht
## Integrating bug fixes and features into your old fork
Have you published your own website by forking { Personal } and now you want to get the latest bug fixes and features from this repo into your website? Then check [this](https://github.com/PanosSakkos/personal-jekyll-theme/wiki/How-to-integrate-latest-bug-fixes-and-features-into-your-past-fork) out.
Have you published your own website by forking { Personal } and now you want to get the latest bug fixes and features from this repo into your website?
Then check [this](https://github.com/PanosSakkos/personal-jekyll-theme/wiki/How-to-integrate-latest-bug-fixes-and-features-into-your-past-fork) out.
## Supporting the repo

21
_posts/2015-06-25-initial-setup.md
View file

@ -6,7 +6,7 @@ category: tech
tags: [ 'tutorial' ]
---
All features of { Personal } are controlled by setting values to variables that exist in the
All features of { Personal } are controlled by setting values to variables that are defined in the
\_config.yml file. Let's start with the initial variables that you have to set before
serving your { Personal } website for the first time.
@ -25,15 +25,9 @@ url: "https://panossakkos.github.io"
# NB! Without this *nothing* will work, because it's used in every path :)
baseurl: /personal-jekyll-theme
# Google tracking id to track your visitors
google-tracking-id: "UA-35880426-4"
</code></pre>
The url and baseurl variables are essential, because they are used *everywhere* where an anchor is defined!
The Google tracking code will be placed in every generated page.
If you don't want Google analytics tracking your website's traffic, set the google-tracking-id to an empty string.
### HTTPS
@ -46,10 +40,6 @@ you don't want to issue one, then you can disable this feature by setting the fo
variable to False:
<pre><code data-trim class="yaml">
# Forces https everywhere in your website, except when you serve it locally
# If you are not hosted on Github Pages, and your host doesn't support https
# then you should disable it
force-https: True
</code></pre>
@ -67,6 +57,15 @@ favicon: "/img/favicon.ico"
The values that you set, will be placed in the head section of every generated HTML page.
### Google Analytics
The Google tracking code will be placed in every generated page.
If you don't want Google analytics tracking your website's traffic, set the google-tracking-id to an empty string.
<pre><code data-trim class="yaml">
google-tracking-id: "UA-35880426-4"
</code></pre>
### Serving { Personal }
Install the required dependencies: