README.md

Yuki

❄️ Hugo theme yuki. She is as pure as the snow.

Features

• Responsive
• Syntax highlighting with highlightjs
• Social links（Customize）
• Custom Pages
• Support for Related Content
• Support for tags
• Google Analytics
• SCSS

Table of Contents

• Quick Start
• Usage
• Development
• License

Quick Start

In your hugo site directory, run:

$ mkdir themes
$ cd themes
$ git clone https://github.com/iCyris/hugo-theme-yuki

Usage

Use hugo's -t hugo-theme-yuki or --theme=hugo-theme-yuki option with hugo commands.

e.g.

$ hugo server -t hugo-theme-yuki

Configuration

Please see the sample config.toml.

Creating Posts

Posts should generally go under a content/post directory. Typically you would run:

hugo new post/your-new-post.md

For posts to appear on your site, you may need draft = false in the post's front matter or use the --buildDrafts option when building.

Creating Custom Pages

Custom pages such as an About page should preferably go under content/pages or be present at the root of the content directory.

hugo new pages/about.md

Development

If you're contributing CSS changes, there are two ways:

1. Simply make changes on /static/scss/custom.css, the style will be overwrited.
2. Use SASS. Directly make changes on the *.scss files and recompile style.scss or highlight.scss.

License

Licensed under the MIT License. See the LICENSE file for more details.