Cactus

A responsive, clean and simple Hexo theme for a personal website.

🌵 Demo

Summary

• General
• Features
• Install
• Configuration
• License

General

• Version : 3.0
• Compatibility : Hexo 3 or later

Features

• Fully responsive
• Multiple color schemes
• Pick your own code highlighting scheme
• Configurable navigation menu
• Support for local search
• Projects list
• I18n support
• Disqus integration
• Utterances integration
• Google analytics / Baidu Tongji
• Font Awesome icons
• Simplicity
• Supports device's Dark Mode!

Install

1. In the root directory:

   $ git clone https://github.com/probberechts/hexo-theme-cactus.git themes/cactus
   

2. Change the theme property in the config.yml file.

   # theme: landscape
   theme: cactus

   See below for more information on how to customize this theme.

3. Create pages and articles with the hexo new [layout] <title> command. For example, to create an "about me" page, run:

   $ hexo new page about

   This will create a new file in source/about/index.md Similary, you can create a new article with

   $ hexo new post "hello world"

   and add some interesting content in source/_posts/hello-world.md.

4. Run: hexo generate and hexo server

5. Publish your blog!

Configuration

You can (and should) modify a couple of settings. An overview of all settings can be found in _config.yml. The most important ones are discussed below.

There are two possible methods to override the defaults. As a first option, you could fork the theme and maintain a custom branch with your settings. Alternatively, you can configure it from your site's primary configuration file. Therefore, define your custom settings under the theme_config variable. For example:

# _config.yml
theme_config:
  colorscheme: white

# themes/cactus/_config.yml
colorscheme: dark

This will override the default black colorscheme in themes/cactus/_config.yml.

Color scheme

Currently, this theme is delivered with two color schemes: dark, light, though you don't need to provide any color scheme since this theme automatically reads system's dark mode value and applies appropriate theme.

Alternatively, you can easily create your own color scheme by creating a new file in source/css/_colors.styl.

Navigation

Setup the navigation menu in the _config.yml:

nav:
  Home: /
  About: /about/
  Writing: /archives/
  Projects: http://github.com/probberechts
  LINK_NAME: URL

Blog posts list on home page

You have two options for the list of blog posts on the home page:

• Show only the 5 most recent posts (default)

  posts_overview:
    show_all_posts: false
    post_count: 5

• Show all posts

  posts_overview:
    show_all_posts: true

Projects list

Create a projects file source/_data/projects.json to show a list of your projects on the index page.

[
    {
       "name":"Hexo",
       "url":"https://hexo.io/",
       "desc":"A fast, simple & powerful blog framework"
    },
    {
       "name":"Font Awesome",
       "url":"http://fontawesome.io/",
       "desc":"The iconic font and CSS toolkit"
    }
]

Social media links

Cactus can automatically add links to your social media accounts. Therefore, update the theme's _config.yml:

social_links:
  github: your-github-url
  twitter: your-twitter-url
  NAME: your-NAME-url

where NAME is the name of a Font Awesome icon.

Language configuration

If you are new to Hexo and internationalization (i18n), please read Hexo documentation - internationalization (i18n) section

Currently, the theme is delivered with support for:

• English (en), default
• Brazilian Portuguese (pt-br)
• Catalan (ca)
• Chinese (Simplified, PRC) (zh-CN)
• Dutch (nl)
• French (fr)
• Italian (it)
• Persian (fa)
• Russian (ru)
• Spanish (es)

If you would like to use one the languages listed above, simply set language to the desired language (e.g., fr) in _config.yml. Otherwise, you can follow the steps below (E.g., to add a Japanese (ja) translation):

1. Set language to ja in Hexo configuration file _config.yml
2. Create a ja.yml file in the themes/cactus/languages/ folder
3. Copy the content of themes/cactus/languages/default.yml and paste it it into the ja.yml file
4. Replace all English strings by their Japanese translation

Note: Cactus does not support multi-language sites.

RTL support

This theme support RTL languages for Persian and Arabic language. If you would like to use RTL layout, change direction attribute in _config.yml to rtl. Note that this also will change the font to Vazir, wich is a Persian font.

direction: rtl

RSS

Set the rss field in the _config.yml to one of the following values:

1. rss: false will totally disable rss (default).
2. rss: atom.xml sets a specific feed link.
3. rss:leave empty to use the hexo-generator-feed plugin.

Analytics

Add you Google Analytics or Baidu Tongji tracking_id to the _config.yml.

google_analytics:
  enabled: true
  id: 'UA-49627206-1'

baidu_analytics:
  enabled: true
  id: 2e6da3c375c8a87f5b664cea6d4cb29c

Comments

Disqus

First, create a site on Disqus: https://disqus.com/admin/create/.

Next, update the _config.yml file:

disqus:
  enabled: true
  shortname: SITENAME

where SITENAME is the name you gave your site on Disqus.

Utterances

First, install Utterances App on your repo. Next, update the _config.yml file:

utterances:
  repo: REPOPATH
  theme: github-light

where REPOPATH is the repo you've installed Utterances app.

Code Highlighting

Pick one of the available colorschemes and add it to the _config.yml:

highlight: COLORSCHEME_NAME

Tags and categories

Tags and categories can be included in the front-matter of your posts. For example:

title: Tags and Categories
date: 2017-12-24 23:29:53
tags:
- Foo
- Bar
categories: 
- Baz
---

This post contains 2 tags and 1 category.

You can create a page with a tag cloud by running:

$ hexo new page tags

Next, add type: tags to the front-matter of source/tags/index.md. You can also add a tag cloud to the home page by setting the tags_overview option to true.

Similarly, you can create a page with an overview of all categories by running:

$ hexo new page categories

and adding type: categories to the front-matter of source/categories/index.md.

Finally, don't forget to create a link to these pages, for example in the navigation menu:

nav:
  tags: /tags/
  categories: /categories/

Local search

First, install the hexo-generate-search plugin, which will generate a search index file.

$ npm install hexo-generator-search --save

Next, create a page to display the search engine:

$ hexo new page search

and put type: search in the front-matter.

title: Search
type: search
---

Finally, edit the _config.yml and add a link to the navigation menu.

nav:
  search: /search/

License

MIT