xianmin/hugo-theme-jane

V3 Upgrade Notice

hugo-theme-jane just had a major update, please check out: Jane Theme V3 Major Update & Hugo-Theme-Jane V3 Upgrade Notice !!! · xianmin/hugo-theme-jane · Discussion #397

jane-preview

hugo-theme-jane

Jane is a readable theme for Hugo. Many color schemes to choose, and easy to personalize. Working well since 2018.

Demo | 中文说明

Key features:

Better reading experience
Use Pico CSS as the color scheme, allowing theme color switching and dark/light mode toggle.
Style Settings, located at /assets/sass/_settings.scss .
Responsive and mobile friendly
Multilingual Mode support
Better Pagination, TOC, footnote behavior
Use the awesome Chroma syntax highlighting
Custom css, Custom js, Custom head support
Sub menu support
Search Optimization

Development Philosophy of This Theme

No node_modules - fewer dependencies make maintenance easier.
Encourages users to modify the theme according to personal preferences for a more personalized website.
Reading Experience is the top priority.
Deploy once, focus on writing, no more hassle.

Real-world examples

crazyoptimist

Quick Start

Note: This tutorial assumes that you are using Hugo for the first time . Hugo is one of the most popular open-source static site generators. You can check the Hugo Official Docs for more help.

1. Install Hugo & Dart Sass

Download the appropriate version for your platform from Hugo Releases. Once downloaded, the binary can be run from anywhere. Ideally, you should install it somewhere in your PATH for easy use. /usr/local/bin is the most probable location.

Install Dart Sass, refer to the official documentation: https://gohugo.io/hugo-pipes/transpile-sass-to-css/#dart-sass .

2. Create a New Site

hugo new site myBlog

The above will create a new Hugo site in a folder named myBlog.

3. Use Hugo-Theme-Jane

Clone this repository into themes folder:

cd myBlog
git clone https://github.com/xianmin/hugo-theme-jane.git --depth=1 themes/jane

Alternative, installation as a module

If you have [Go](https://go.dev/) installed you can install the theme as a [hugo module](https://gohugo.io/hugo-modules/), then there will be no need to clone it into the `themes` folder: ```bash hugo mod init example.com/my-blog ``` After that, you would need to use `github.com/xianmin/hugo-theme-jane` as your `theme` and not `hugo-theme-jane` in your `config.toml` file.

Copy the example site content:

cp -r themes/jane/exampleSite/content ./

Copy the default site config:

cp themes/jane/exampleSite/hugo.toml ./

Take a look at the example site:

hugo server

Open http://localhost:1313/ , you will see your site running with the example content.

4. Start a Blog

The default config file hugo.toml is located in your site root directory. You can customize it to match the details of your site. Documentation about configuring Hugo can be found in the Official Documentation

The default content files are located in the ./content/post directory.

5. Generate Your Website

Run hugo , this generates your website to the public/ directory by default.

Nice work!

If you have extra time or want to know more about Hugo , check out the awesome Hugo Official Docs .

Site Configuration

Take a look in the exampleSite folder.

This directory contains an example config file and the content for the demo. It serves as an example setup for you to configure to your liking.

Copy the hugo.toml to the root directory of your website. Overwrite the existing config file if necessary.

Single Post Configuration

Front Matter : Hugo allows you to add front matter in yaml, toml, or json to your content files.

YAML Example:

---
# Common-Defined
title: "An Example Post"
date: 2018-01-01T16:01:23+08:00
lastmod: 2018-01-02T16:01:23+08:00
draft: false
tags: ["tag-1", "tag-2", "tag-3"]
categories: ["index"]
author: "xianmin"

# User-Defined
# You can close(false) or open(true) something for this content.
# P.S. comment can only be closed
comment: false
toc: false
# You can also define another contentCopyright
contentCopyright: '<a rel="license noopener" href="https://creativecommons.org/licenses/by-nc-nd/4.0/" target="_blank">CC BY-NC-ND 4.0</a>'
reward: false
mathjax: true
---

Multilingual (Language) Support

Hugo-Theme-Jane supports the creation of websites with multiple languages side by side.

You should define the available languages in a languages section in your site configuration.

Translations are collected from the i18n/ folder.

To use the translations:

# use Chinese translation
defaultContentLanguage = "zh-cn"  # Default language to use (if you set up multilingual support)
[Languages.zh-cn]
  languageCode = "zh-cn"

To use the Multilingual Mode, see Multilingual Mode | Hugo .

Contributing

If you are interested in fixing issues and contributing directly to this theme, please see the document How to Contribute .

There are many ways to contribute to the Jane theme:

submitting pull requests
reporting issues
providing new translations
creating suggestions
correct inappropriate English expression (ok, my English is not good)

Contributors

This project exists thanks to all the people who contribute:

License

Hugo-theme-jane is licensed under the MIT license. Check the LICENSE file for details.