Merge pull request #14 from b0ch3nski/improvements

Multiple improvements :)

README.md

@@ -10,44 +10,45 @@ Theme to build a customizeable printable HTML/CSS CV.
  - Customizeable colors
 
 ## Print your PDF CV
-When printing the page in the browser, you'll get a formatted A4 page that can be used as your PDF resume. 
+When printing the page in the browser, you'll get a formatted A4 page that can be used as your PDF resume.
 If your page holds more than 1 A4 page, the content will be divided into the given amount of pages.
 
 For better formatting, you can set the number of pages in the `config.toml` file.
 
 If badges and other elements with background don't render correctly, remember to toggle the "Background Graphics" option in the print dialog.
 
-# Download 
-Clone the repo: `git clone https://github.com/ineesalmeida/almeida-cv`
+# Usage
+## Install Hugo (extended)
+To use `almeida-cv` theme you need to install Hugo Extended by following https://gohugo.io/getting-started/installing/.
 
-# Installation
-## Install Hugo (Extended)
-To use almeida-cv theme you need to install Hugo Extended by following https://gohugo.io/getting-started/installing/.
-
-## Create your personal website and run
+## Create your personal website
 ```
 hugo new site <your website's name>
-cd <your website's name>/themes/
+cd <your website's name>
+git init
+git submodule add https://github.com/ineesalmeida/almeida-cv.git themes/almeida-cv
 ```
-Clone the theme (`git clone https://github.com/ineesalmeida/almeida-cv`) into your themes folder.
-Replace the files in your root's directory with the ones on `themes/almeida-cv/exampleSite`.
+Replace the files in your site root's directory with the ones in `themes/almeida-cv/exampleSite`.
+
+## Start Hugo in development mode
 ```
 hugo server -D
 ```
-The theme is alive on http://localhost:1313/.
+Your site is now available at http://localhost:1313/.
 
 ## Customization
-You can change the theme colors and number of pages in the `config.toml` file.
-Your professional data should be added in the `data/content.yaml`.
+Your professional data should be added in the `data/content.yaml` file. You can change the theme colors and number of
+pages in the `config.toml` file. For working example, see `exampleSite` directory.
 
+For more advanced customization, in your site root directory create `assets/scss/_custom.scss` file where you can
+overwrite theme SCSS as per your liking.
 
-# Building 
-To generate your site in the public folder, execute the following:
+## Building
+To generate static files of your website, execute the following:
 ```
-hugo
+hugo --minify
 ```
 within the root of your project.
 
-
-# Contributing 
+# Contributing
 Post bugs and contributions to the issue tracker. Or make a pull request.

assets/scss/_custom.scss

@@ -0,0 +1 @@
+// override me

assets/scss/main.scss

@@ -1,5 +1,3 @@
-
-// HUGO variables
 $color-primary: {{ .Site.Params.colorPrimary | default "#e3bfb8"}} !default;
 $color-primary-text: {{ .Site.Params.colorPrimaryText | default "#fff"}} !default;
 $color-background: {{ .Site.Params.colorPageBackground | default "#ddd" }} !default;
@@ -25,5 +23,6 @@ $pages: {{ .Site.Params.pages | default 1}} !default;
 @import "components/skills";
 @import "components/languages";
 @import "components/interests";
+@import "components/404";
 
-@import "components/404";
+@import "custom";

exampleSite/config.toml

@@ -1,7 +1,12 @@
-baseURL = "https://example.com/"
 languageCode = "en-us"
 defaultContentLanguage = "en"
+enableRobotsTXT = "true"
+enableEmoji = "true"
+
 theme = "almeida-cv"
+disableKinds = ["page", "section", "taxonomy", "term", "RSS", "sitemap"]
+
+baseURL = "https://example.com/"
 title = "Example - CV"
 
 [params]

exampleSite/resources/_gen/assets/scss/sass/main.scss_545d7c693f5b5f74d129019eb310e64e.json

@@ -1 +0,0 @@
-{"Target":"style.main.min.33da6b12aa464369a4d67eff5abf33f911e1a5d1c1fb8b3959f6049be2321f60.css","MediaType":"text/css","Data":{"Integrity":"sha256-M9prEqpGQ2mk1n7/Wr8z+RHhpdHB+4s5WfYEm+IyH2A="}}

i18n/pl.toml

@@ -0,0 +1,20 @@
+[profile]
+other = "Profil"
+
+[experience]
+other = "Doświadczenie"
+
+[education]
+other = "Wykształcenie"
+
+[skills]
+other = "Umiejętności"
+
+[languages]
+other = "Języki"
+
+[diplomas]
+other = "Dyplomy"
+
+[interests]
+other = "Zainteresowania"

layouts/partials/head.html

@@ -3,11 +3,16 @@
     <meta name="viewport" content="width=device-width, initial-scale=1.0">
     <title>{{ .Site.Title }}</title>
 
-    <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Oswald">
-    <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto">
-    <link rel="stylesheet" href="https://pro.fontawesome.com/releases/v5.10.0/css/all.css" integrity="sha384-AYmEC3Yw5cVb3ZcuHtOA93w35dYTsvhLPVnYs9eStHfGJvOvKxVfELGroGkvsg+p" crossorigin="anonymous"/>
-    <link href="https://fonts.googleapis.com/icon?family=Material+Icons" rel="stylesheet">
+    <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Oswald" />
+    <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto" />
+    <link rel="stylesheet" href="https://fonts.googleapis.com/icon?family=Material+Icons" />
+    <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.3/css/all.min.css" integrity="sha512-iBBXm8fW90+nuLcSKlbmrPcLa0OT92xO1BIsZ+ywDWZCvqsWgccV3gFoRBv0z+8dLJgyAHIhR35VZc2oM/gI1w==" crossorigin="anonymous" referrerpolicy="no-referrer" />
 
-    {{ $style := resources.Get "sass/main.scss" | resources.ExecuteAsTemplate "style.main.scss" . | toCSS | minify | fingerprint }}
-    <link rel="stylesheet" href="{{ $style.RelPermalink }}" integrity="{{ $style.Data.Integrity }}" crossorigin="anonymous" media="screen" />
-</head>
+    {{- $style := resources.Get "scss/main.scss" | resources.ExecuteAsTemplate "style.main.scss" . | toCSS | minify | fingerprint }}
+    <link rel="stylesheet" href="{{ $style.RelPermalink }}" integrity="{{ $style.Data.Integrity }}" crossorigin="anonymous" media="screen,print" />
+
+    {{- if .Site.GoogleAnalytics }}
+        {{ template "_internal/google_analytics.html" . }}
+        {{ template "_internal/google_analytics_async.html" . }}
+    {{- end -}}
+</head>