Skip to content
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
archetypes
assets
layouts
static
LICENSE
README.md
theme.toml

README.md

Spark

By default, a dark and responsive Hugo theme. Typography used is Space Mono, monospace. I have designed this theme specifically for researchers or PhD candidates but anyone can use it.

Demo

Table of Content

Screenshot

1. Features

  • Responsive, uses UiKit v3
  • Suitable for researchers, PhD candidates, personal website and bloggers
  • Disqus support
  • Google Ads support (Only for blogs)
  • Google analytics support
  • Inline CSS and JS, no need of cache bursting
  • Uses SASS/SCSS, no NodeJS needed
  • Can change the colour of the theme
  • Education and experience data files
  • Search index json file (with Algolia support)
  • Custom sitemap with images support, custom stylesheet, priority and change frequency
  • Structured data for website and articles
  • With blog pagination and categories
  • Support for external links in blog

AMP coming soon.

2. Quick Start

From the root of your Hugo site, clone the theme into themes/Spark by running:

# Clone theme into the themes/cocoa directory
$ git clone https://github.com/akshaybabloo/spark-hugo-theme.git themes/Spark

3. Usage

3.1. Configuration

Please see the configuration here. This theme is built on Hugo v0.51+.

3.2. Front Matter

I have divided this theme into four (kinda strict way) ways:

  1. about - Write about yourself, this page also uses Education.json and Experience.json data files.
  2. blog - Lists out unique tags only related to blog and has ads associated with it.
  3. projects - You can link to external website.
  4. sitemap.xml - With images and ignores url.

For this reason the front matter is somewhat unique to each of them.

3.2.1. All Pages

  1. When you use images: [] the first index will be taken as the thumbnail image for the meta tag, if not thumbnailUrl = "/img/akshay.jpg" under [params] is taken into consideration.

3.2.2. about Page

No unique front matter as such but I do use the Education.json and Experience.json data files, see here for how they are formatted.

3.2.3. blog Page

New front matter as ads: false (by default), make sure you have googleAds under [params].

3.2.4. projects Page

projectCategory: "" is where you give the category of the project (duh!) the list.html page is grouped by this.

3.2.5. sitemap.xml page

siteMapImages:
  - imageLoc: "/image1.png"
    imageCaption: "It's caption"
  - imageLoc: "/image2.png"
    imageCaption: "It's caption"

The image title is taken as the page title {{ .Title }}.

3.2.6. searchindex.json Search Index

Make sure you add the following in your config.toml file for searchindex.json to generate:

[outputFormats]
  [outputFormats.searchindex]
    mediaType= "application/json"
    baseName= "searchindex"
    isPlainText= true


[outputs]
  home= ["HTML","RSS", "searchindex"]

3.3. Data files

There are two data files that can be used to print out your education and experiences.

3.3.1. Education.json

Format:

{
  "Education": [
    {
      "title": "Title of degree",
      "where": "name of university, location",
      "from": 2007,
      "to": 2011
    }
  ]
}

3.3.2. Experience.json

Format:

{
  "Experience": [
    {
      "title": "title of job",
      "company": "company name.",
      "where": "location",
      "from": "month, year",
      "to": "month, year",
      "current": false
    }
  ]
}

If the current is set to true or if to set to Present, the block is highlighted.

4. Development

For theme changes, I am using Hugo's SCSS build capabilities (no need of NodeJS) at custom.scss. All PR's are accepted as far as they follow the OSS standards.

UiKit v3 is still in beta, I'll update them whenever there are any new updates available.

Didn't bother to decorate _default/list.html but PRs are welcome.

5. License

Licensed under the MIT License. See the LICENSE file for more details.

You can’t perform that action at this time.