Skip to content

BiosElement/hugo-theme-diary

 
 

Repository files navigation

hugo-theme-diary

隻言片語・於此匯聚

Moments piled up.

A Hugo theme ported from SumiMakito/hexo-theme-Journal.

Links

Some useful links here:

Live Demo

Intro Video

Changelog (Progress and TODO List)

Project Wiki

Original Author: SumiMakito

Features

Features in the ori.:

  • Simple and easy to customize
  • Concentrated on reading and writing (find a Markdown editor then) experience
  • Mobile-friendly & widescreen-friendly
  • Flexible commenting control

Features in this ported version:

  • Add Gitalk and Valine intergration.
  • Customizable color scheme. (Some bug in original version, fixed.)
  • Firefox-friendly. (CSS issue in original version, fixed.)
  • featured_image url bug is fixed.
  • Table of Contents with scroll spy and auto collapse.
  • Dark mode.
  • MathJax support. (Needs to be enabled manually, see the project wiki for details.)
  • Google Custom Search Engine support.
  • Internationalization(i18n) support, with English, French and Chinese(Simplified and Traditional).
  • Inserting figures more easily, see wiki for details.

Quick Start

If your website is using Git as version control, please do as follows:

  1. Fetch the theme dir.

From the root of your Hugo site, open the terminal and execute:

git submodule add https://github.com/AmazingRise/hugo-theme-diary.git themes/diary
  1. Update git repository.

Then update the git repository from the root of your site:

git submodule update --remote --merge
  1. Run example site.

From the root of themes/diary/exampleSite:

hugo server --themesDir ../..

Personalization

Example config

See /exampleSite/config.toml

Customization

Please visit the project wiki for more details.

Settings of Table of Contents

Disable Dark Mode

Enable MathJax

Add or disable comment area

Add Google Search Box on your site

Customizations

Taxonomies and Sections (Archive, Categories and Tags)

RSS Feed

Meta Data of posts

Enable Reading Time

Internationalization

Comparison

For details about the difference lies in the new version, please click here.

Screenshots

Site Main Page

An essay with picture.

Table of Contents with scroll spy.

Mobile View: Main Page

Mobile View: Drawer

About

Moments piled up. A Hugo theme ported from SumiMakito/hexo-theme-Journal.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • HTML 44.4%
  • CSS 41.1%
  • JavaScript 14.5%