Giter Club home page Giter Club logo

zett's Introduction

Zett

Hugo theme for creating a digital garden based on Zettelkästen. Original work by Crisrojas from Zettels. Checkout gumroad for supporting the original author.

Demo

https://acien101.gitlab.io/

Minimum Hugo version

You will need Hugo extended version in order to support Sass/SCSS.

Hugo version 0.60.1 or higher is required. View the Hugo releases and download the binary for your OS.

Installation

From the root of your site:

git submodule add https://github.com/acien101/Zett themes/Zett

Updating

From the root of your site:

git submodule update --remote --merge

Run example site

From the root of themes/Zett/exampleSite:

hugo server --themesDir ../..

Configuration

Copy config.yaml from the exampleSite, then edit as desired.

Favicons

Upload your image to RealFaviconGenerator then copy-paste the generated favicon files under assets.

Linking notes

This theme includes [[wikilinks]] support.

If you want to link a note, just put it's file name inside two brackets.

That means that for the note:

biology.md

You would link it like this

[[biology]]

Output:

<a href="biology.html">biology</a>

Make sure your filenames contain not spaces as this isn't supported by the regex yet.

DO

biologia-celular.md ✅
[[biologia-celular]] ✅

DON'T

biología celular.md ⛔️
[[biología celular]] ⛔️

Your markdown notes go inside the content folder and need to comply with a valid yaml syntax if you're using metadata

Backlinks

Backlinks are supported right out the box. To use them properly you would want to give a title to each of your notes in the yaml header, like so:

---
title: My awesome note
---

Hi! This is the content of my awesome note.

This way the note can be referenced in the backlinks section since the backlink function will look for the title key.

MathJax

You can write math equations using latex syntax.

For multi-line equations:

$$
\sqrt{\frac{\lambda}{\ro}}
$$

For inline equations you can use \\(\Omega_{124}\\)

zett's People

Contributors

acien101 avatar crisrojas avatar tbm avatar

Stargazers

Celestial-Entity avatar María A. Matienzo avatar At ivory tower avatar Cristóbal Contreras Rubio avatar

Watchers

James Cloos avatar  avatar

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.