https://github.com/zxdawn/allinone
https://github.com/zxdawn/allinone
Last synced: 7 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/zxdawn/allinone
- Owner: zxdawn
- License: mit
- Created: 2022-12-20T05:25:12.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-02-19T04:20:12.000Z (over 3 years ago)
- Last Synced: 2024-12-28T14:48:13.818Z (over 1 year ago)
- Language: CSS
- Size: 14.8 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# AllinOne - Hugo theme
This theme is an updated version of the [original AllinOne](https://github.com/orianna-zzo/AllinOne) theme by [Orianna](https://github.com/orianna-zzo).
This theme has been updated to work with `Hugo 0.74`.
> NB: Docs are out of date and are referencing the previous repository.
## Preview
[Demo](https://orianna-zzo.github.io/AllinOne-html/)
Here are some screen shots:
## Features
- Responsive full image carousel (Responsive text layout on it should be improved)
- Suited for blogging and personal webpages with static profile image (avatar) and website image (`faviconfile`)
- Smooth scroll && hierarchical `Scrollspy` for table of contents (`h1~h4`)
- Syntax highlighting with highlightjs
- Katex for Latex
- Google Analytics
- Font Awesome 3.1.0
- Built-in Tags, Series and Categories && show recommendations of the section in the sidebar
- Built-in pagination for sections
- Previous/Next post button
- Post card list with summary (with/without an intro picture) && Series card list in the sidebar
Most features are optional and can be individually enabled/disabled in your `config.toml`.
## Table of Contents
- [AllinOne - Hugo theme](#allinone---hugo-theme)
- [Preview](#preview)
- [Features](#features)
- [Table of Contents](#table-of-contents)
- [Quick Start](#quick-start)
- [Usage](#usage)
- [Configuration](#configuration)
- [Carousel Picture](#carousel-picture)
- [Post Intro Picture](#post-intro-picture)
- [Post Summary](#post-summary)
- [Series Intro Picture](#series-intro-picture)
- [License](#license)
- [Thanks](#thanks)
## Quick Start
From the root of your Hugo site, clone the theme into `themes/AllinOne` by running:
```sh
# Clone theme into the themes/AllinOne directory
$ git clone https://github.com/EliiseS/AllinOne.git themes/AllinOne
```
## Usage
### Configuration
Please see the sample [`config.toml`](https://github.com/EliiseS/AllinOne/blob/master/exampleSite/config.toml). The latest Hugo version this theme has been built on is `0.92.0`.
If you use this as a theme of your project website (not the root directory),make sure not to use a forward slash `/` in the beginning of a `PATH` in your `config.toml`, `img` in your post head and `url` in your data directory, because Hugo will turn it into a relative URL and the `absURL` function will have no effect.
### Carousel Picture
Set two parameters in `config.toml`, `slidesDirPath` and `slidesDirPathURL`.
`slidesDirPath` sets the directory path for Hugo server to search. `slidesDirPathURL` sets the rel url for the images.
Here are simple examples for quick start.
```toml
# if you want to use images in the theme (defult in the theme)
slidesDirPath = "themes/AllinOne/static/img/header-slides"
slidesDirPathURL = "img/header-slides"
# if you want to use images in static/img/header-slides
slidesDirPath = "static/img/header-slides"
slidesDirPathURL = "img/header-slides"
```
### Post Intro Picture
List the image path in the `YAML` head of the post. For example:
```YAML
---
date: "2018-08-13T00:14:19+08:00"
publishdate: "2018-08-13+08:00"
lastmod: "2018-08-13+08:00"
draft: false
title: "This is an example"
tags: ["css", "blog"]
series: ["Example"]
categories: ["Sci"]
img: "images/blog/2018-08/test5.jpg"
toc: true
summary: "This is an example of adding an intro picture to the post. "
---
```
### Post Summary
There are three ways to add summary to each post.
- [Hugo-defined Summary Split](https://gohugo.io/content-management/summaries/)
By default, Hugo automatically takes the first 70 words of your content as its summary and stores it into the `.Summary` page variable for use. It is much easier with no additional work, but it might not the one you want.
If Chinese/Japanese/Korean (CJK) languages are in the content, set `hasCJKLanguage` as `true` in the `config.toml`, so that Hugo could auto detect CJK languages to make `.Summary` and `.WordCount` behave correctly. [See here](https://gohugo.io/getting-started/configuration)
The length of text to show in a `.Summary` could be set as `summaryLength` in `config.toml`. [See here](https://gohugo.io/getting-started/configuration/)
- [User-defined Summary Split](https://gohugo.io/content-management/summaries/)
Alternatively, you may add the \