Giter VIP home page Giter VIP logo

hugo-swift-theme's Introduction

Swift Theme

This theme is designed for blogging purposes. Feel free to extend it for other use cases though.

At its core, it's minimalistic; it doesn't rely on monolithic libraries such e.g jquery, bootstrap. Instead, it uses grid css, flexbox & vanilla js to facilitate the features outlined below:

Hugo Swift Theme

Features

Installation

Add this theme as a Git submodule inside your Hugo site folder:

git submodule add https://github.com/onweru/hugo-swift-theme.git themes/hugo-swift-theme

Theme hugo sass and hugo-extended version.

Configuration

You can configure the site using as follows:

  1. General Information** and **Staticman config

    Use the file config.toml.

  2. menu, footer

    See the data files inside the data/ directory.

    Follow the exampleSite/.

  3. Customize Theme colors You can do so easily in the variables sass partial. Use names (e.g red, blue, darkgoldenrod), rgb, rgba, hsla or hex values.

Staticman Comments

By default, Staticman comments are disabled. To enable them, you may refer to the Staticman config Wiki.

Written By Block

How do I include a written by ?

  1. Copy this authors yaml file from the exampleSite to your data directory.
- name: "yourName"
  photo: "myAvatar.jpg"
  url: "https://myURLofChoice.domain"
  bio: "It's time to flex. Write a short or not-so-short summary about yourself."
  1. Specify the name in your content files
...
author: "yourName"
...

What if I want to exclude the written by from some articles?

Don't include an author in your article front matter.

The authors.yml file helps yoy:

  1. Write all your author information in one place. This way, you only specify the author name on your content files (posts). The rest of the data i.e photo, url & bio are automatically pulled from the data file.

  2. In certain situations, you may have different people publishing articles on your blog. For example, you could have someone guest blog. Or may be you have a blog co-author.

Deeplinks

For all content published using markdown, deeplinks will be added to the pages so that you can share with precision ๐Ÿ˜ƒ Just hover on a heading and the link button will pop. Click it to copy.

Dark Mode

Today most operating systems & browsers support dark mode. Like twitter, which automatically turns into dark mode when the user chooses darkmode, this theme does the same thing.

Dark Mode

License

The code is available under the MIT license.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.