GithubHelp home page GithubHelp logo

zink's Introduction

Zink

Crisp, minimal personal website and blog theme for Zola. This is a port of hugo-ink which was originally forked from Ezhil.

The name is inspired by zola and ink.

Ligh theme

blog-light

Dark theme

blog-dark

Demo

https://zola-ink.netlify.app/

Installation

  1. Download the theme
git submodule add https://github.com/varunlakkur/zink themes/zink
  1. Add theme="zink" to your config.toml
  2. Copy example content from theme to the main content
cp -r themes/zink/content/* content/
  1. Add theme=zink to the main section of config.toml

Override

You can override the contents of the main page by extending the index.html file.

{% extends "index.html" %}

{% block content %}
Your new content goes here
{% endblock content %}

Analytics can be added by extending the analytics block

{% extends "index.html" %}

{% block analytics %}
Your new content goes here
{% endblock analytics %}

Options

All the options go into [extra] section

zink_avatar (optional):

Avatar to be displayed on beside the site title

####zink_social: Links to your SM profiles like twitter and github

Example:

zink_social = [
    {url = "https://github.com/varunlakkur/zola", name = "Github", icon = "github"},
    {url = "atom.xml", name = "RSS", icon = "rss"},
]

zink_links:

The menu items to be displayed on the nav bar.

Example:

zink_links = [
    {url = "/", name = "Home"},
    {url = "/blog", name = "Blog"},
    {url = "/about", name = "About"},
    {url = "/tags", name = "Tags"},
]

zink_recent:

Decides whether to display the Recent Posts on the main page

zink_recent_items (Optional):

Num of recent posts to be displayed.

Acknowledgements

  • Ported hugo-ink with zola specific changes
    • The layout and the theme is identical to ink
    • The css files and js files are from ink (Thanks knadh)
  • Skeleton of the templates are taken from mr-karan's website

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.