updated documentationpost

_posts/2015-06-25-html-head-tutorial.md

@@ -1,46 +0,0 @@
----
-layout: post
-section-type: post
-title: Modifying the HTML HEAD
-category: tech
-tags: [ 'tutorial' ]
----
-
-In the \_config.yml, find and set the variables of the Head section:
-
-<pre><code data-trim class="yaml">
-#############
-# HTML Head #
-#############
-
-author: "John Smith"
-lang: "en"
-title: "{ John Smith }"
-favicon: "/img/favicon.ico"
-description: "Blog and website of John Smith, blogging mainly for tech. Opinions expressed are mine."
-keywords: "smith, jones, personal, Jekyll, theme"
-</code></pre>
-
-The values that you set, will be placed in the head section of every generated HTML page.
-
-Don't forget to set the configurations for your site's url and Google tracking id:
-
-<pre><code data-trim class="yaml">
-url: "http://panossakkos.github.io/personal-jekyll-theme/"
-google-tracking-id: ""
-</code></pre>
-
-The url is essential to be set, because it's used in many places across the theme.
-
-The Google tracking code will be placed in every generated page.
-If you don't want Google tracking, set it to an empty string, or simply remove the definition from the configuration file.
-
-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!
-In order to serve the website locally just run:
-
-<pre><code data-trim class="bash">
-./scripts/serve-production
-</code></pre>
-
-<small>Many thanks to <a href="https://github.com/joariasl" target="\_blank">@joariasl</a> for the language support! </small>

_posts/2015-06-25-initial-setup.md

@@ -0,0 +1,67 @@
+---
+layout: post
+section-type: post
+title: Initial setup
+category: tech
+tags: [ 'tutorial' ]
+---
+
+All features of { Personal } are controlled by setting values to variables that exist 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.
+
+<pre><code data-trim class="yaml">
+# NB! Set your site's url, otherwise stuff will break :)
+
+url: "https://panossakkos.github.io"
+
+# If you're hosting your site at a Project repository on GitHub pages
+# (https://yourusername.github.io/repository-name)
+# and NOT your user repository (https://yourusername.github.io)
+# then add in the baseurl here, like this: "/repository-name"
+#
+# 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 to be set, 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 tracking, set it to an empty string.
+
+<pre><code data-trim class="yaml">
+#############
+# HTML Head #
+#############
+
+author: "John Smith"
+lang: "en"
+title: "{ John Smith }"
+favicon: "/img/favicon.ico"
+description: "Blog and website of John Smith, blogging mainly for tech. Opinions expressed are mine."
+keywords: "smith, jones, personal, jekyll, theme"
+</code></pre>
+
+The values that you set, will be placed in the head section of every generated HTML page.
+
+Install the required dependencies:
+
+<pre><code data-trim class="bash">
+gem install jekyll jekyll-paginate jemoji html-proofer
+</code></pre>
+
+Serve the jekyll website:
+
+<pre><code data-trim class="bash">
+./scripts/serve-production
+</code></pre>
+
+And that's it!
+
+You are ready to start hacking around your { Personal } website!
+
+<small>Many thanks to <a href="https://github.com/joariasl" target="\_blank">@joariasl</a> for the language support! </small>