GithubHelp home page GithubHelp logo

ielave / hugo-theme-minima Goto Github PK

View Code? Open in Web Editor NEW

This project forked from mivinci/hugo-theme-minima

0.0 0.0 0.0 6.65 MB

A Clean and minimal Hugo theme porting from Hexo Minima.

Home Page: https://h.xjj.pub

License: MIT License

HTML 50.51% JavaScript 8.04% Makefile 1.22% SCSS 40.24%

hugo-theme-minima's Introduction

Minima

A Hugo port of Hexo Minima. Demo site.

The main branch is in development stage, UI or configuration may vary. You can use the latest stable version here.

screenshot

Features

  • Clean
  • Light/dark mode
  • VSCode-style code hightlighting (the most alike among all Hugo themes)
  • KaTeX
  • Mermaid diagrams
  • Google analytics
  • Disqus/Utterances
  • Optional ToC
  • External link post

Usage

Before using Minima, make sure you've got Hugo (extended version) installed on your device.

Installation

Suppose blog is where you place your sources.

cd blog
git init
git submodule add --depth 1 https://github.com/mivinci/hugo-theme-minima.git themes/minima

Or clone directly if you don't wanna use the Git submodule.

git clone https://github.com/mivinci/hugo-theme-minima.git themes/minima

Anyways, you just need to put Minima under the blog/themes directory.

Configuration

Follow exampleSite/config.toml and edit your own blog/config.toml file.

Supported Front Matters

Field Type Explanation
title string Title of the post
description string Description of the post
date string Datetime when the post is written
link string If set, the post will redirect to an external link
categories array Array of categories the posts belongs to
series array Array of series the post belongs to
tags array Array of tags the posts is related to
math bool True if the post needs to render math formulas
mermaid bool True if the post needs to render mermaid diagrams
comment bool True if the post allows people to make comments
draft bool True if the post isn't already for publishing
toc bool True if the post needs a ToC

External Link Post

Use the link in the front matter to make a post a specific external link. Such external link post will redirect to the link provided.

Example

---
author: XJJ
title: External Link Post
date: 2021-07-17T10:52:59+08:00
link: https://gohugo.io
---

And when you click the title in the list page, you will be redireted to https://gohugo.io which's ๐Ÿ†’.

Feedback

Feedbacks are welcome here.

hugo-theme-minima's People

Contributors

mivinci avatar zonggen 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.