Merge pull request #16 from 526avijitgupta/footer-and-docs

Footer, docs & clean up

README.md

@@ -0,0 +1,40 @@
+# Gokarna
+
+A minimal opinionated theme for Hugo
+
+![Gokarna theme](/docs/screenshot.png)
+
+## Features
+
+- Minimalistic & fast
+- Customizable header
+- Responsive
+- Light/Dark theme toggle
+- Native fonts
+- Syntax highlighting
+- Math typesetting
+- SEO Ready
+
+
+## Inspiration
+
+The theme is inspired by and accordingly named after [Gokarna](https://en.wikipedia.org/wiki/Gokarna,_Karnataka), a small and peaceful beach town on the west coast on India.
+
+![Gokarna](/docs/gokarna.jpg)
+
+
+## Installation
+
+```sh
+git submodule add https://github.com/526avijitgupta/gokarna.git themes/gokarna
+```
+
+## Customization
+
+- Navbar
+- Footer
+- Inject html
+
+## LICENSE
+
+Apache or MIT ?

archetypes/default.md

@@ -1,6 +0,0 @@
----
-title: "{{ replace .Name "-" " " | title }}"
-date: {{ .Date }}
-draft: true
----
-

config.toml

@@ -1,3 +0,0 @@
-baseURL = "http://example.org/"
-languageCode = "en-us"
-title = "My New Hugo Site"

exampleSite/config.toml

@@ -10,6 +10,9 @@ pygmentsStyle = "bw"
 pygmentsCodeFences = true
 pygmentsCodeFencesGuessSyntax = true
 
+[params]
+  footer = "The Marauders"
+
 [menu]
   [[menu.main]]
     name = "Home"

themes/gokarna/layouts/partials/footer.html

@@ -0,0 +1,7 @@
+<footer class="footer">
+    <span>&copy; {{ now.Year }} {{ .Site.Params.Footer}}</span>
+    <br>
+    <span>
+        Made with &#10084;&#65039; using <a href="https://github.com/526avijitgupta/gokarna">Gokarna</a>
+    </span>
+</footer>

themes/gokarna/layouts/partials/header.html

@@ -8,7 +8,7 @@
         </div>
 
         <div class="nav-title">
-            <a class="nav-brand" href="https://example.com">Title title</a>
+            <a class="nav-brand" href="{{ .Site.BaseURL }}">{{ .Site.Title }}</a>
         </div>
 
         <div class="nav-links">

themes/gokarna/static/css/dark.css

@@ -10,6 +10,10 @@ pre {
   color: #e2e2e2 !important;
 }
 
+.footer a {
+    color: #e2e2e2 !important;
+}
+
 /* TODO: Check if this is needed or not */
 /* 
 img,

themes/gokarna/static/css/main.css

@@ -90,6 +90,16 @@ html {
   cursor: pointer;
 }
 
+/* FOOTER */
+.footer {
+    text-align: center;
+}
+
+.footer a {
+  font-family: "Ubuntu", sans-serif;
+  color: #000000;
+}
+
 /** COMMON **/
 /* TAGS */
 .post-tags {