Inside

A SPA, flat and clean theme for Hexo ❤️.

中文文档

Features

Sub-page routes

For example, the directory structure looks like this:

ROOT
  |-source
    |-about
      |-index.md
    |-links
      |-index.md
    |-awesome-stuff
      |-index.md
      |-chapter-1.md
      |-chapter-2.md
    |-amazing-stuff
      |-index.md
      |-chapter-1
        |-index.md
        |-part-1.md
        |-part-2.md

And urls will be:

• /about about/index.md
• /awesome-stuff awesome-stuff/index.md
• /awesome-stuff/chapter-1 awesome-stuff/chapter-1.md
• /awesome-stuff/chapter-2 awesome-stuff/chapter-2.md
• /amazing-stuff amazing-stuff/index.md
• /amazing-stuff/chapter-1 amazing-stuff/chapter-1/index.md
• /amazing-stuff/chapter-1/part-1 amazing-stuff/chapter-1/part-1.md
• /amazing-stuff/chapter-1/part-2 amazing-stuff/chapter-1/part-2.md

Other built-in routes are as follows:

• home: /
• archives: /archives
• tags: /tags
• categories: /categories
• 404: /404

Routes can be configured at site's sidebar directly, for example:

menu:
  home: /
  about: /about
  Awesome Stuff: /awesome-stuff
  Amazing Stuff: /amazing-stuff
  Just Kidding: /404

Multiple languages

• 🇨🇳 Simplified Chinese & Traditional Chinese
• 🇺🇸 English
• 🇯🇵 Japanese

Support 3 languages for now, default is English. Change language at site's configuration file to take effects.

language: en
# language: zh-Hans
# language: zh-Hant
# language: ja

Disqus comments

disqus:
  shortname: your_disqus_shortname
  autoload: true

Set autoload to true to auto load disqus, otherwise will show a button.

Social Media

sns:
  github: your-github-url
  twitter: your-twitter-url
  gplus: your-google-plus-url
  weibo: your-weibo-url

Feed

1. Install hexo-generator-feed:

   npm install hexo-generator-feed --save

2. Config site's configuration file as follows:

   feed:
     path: atom.xml

See hexo-generator-feed for more information.

Assets path

Prefix/Suffix post assets path with assets filter, useful for CDN settings.

assets:
  prefix: 'https://cdn.example.com'
  suffix: '?m=webp&q=80'

For example

![cat](images/cat.gif)

will convert to:

<img src="https://cdn.example.com/images/cat.gif?m=webp&q=80" alt="cat">

Google Analytics

ga: UA-00000000-0

Web App Manifest

Add a manifest.json file for your site.

manifest:
  short_name:
  name:
  start_url: /
  theme_color: '#2a2b33'
  background_color: '#2a2b33'
  icons:
    - src: icon-194x194.png
      sizes: 194x194 512x512
      type: image/png
    - src: icon-144x144.png
      sizes: 144x144
      type: image/png

See here for more information.

Meta Theme Color

By default, #2a2b33 is used as the value of theme-color; if a thumbnail is set, the color of the first pixel of the thumbnail is extracted as theme-color.

Note this only works for Chrome on Android.

See here for more information.

Sitemap

Add a sitemap.xml file for your site.

Enhanced front matter

Inside extended the default front matter with the following properties used by itself:

• author author of the post
• thumbnail picture which shows on your post header
• dropcap capitalizes the first character

None of them are required.

For example:

---
title: You've got to find what you love
date: 2005-06-15
author: Jobs
tags:
 - people
categories:
 - articles
thumbnail: images/people/jobs.jpg
dropcap: true
---

Configuration

Site (ROOT/_config.yml)

Since some of the components provided by Hexo are not satisfactory for use, Inside uses its own implementation. In order to avoid conflicts, it is highly recommended to remove the following generators from site's package.json.

• hexo-generator-archive
• hexo-generator-category
• hexo-generator-tag

And configure the site's _config.yml as follows.

permalink: post/:title/index.html
default_layout: index
pagination_dir: page

Theme (themes/inside/_config.yml)

Full configuration of theme's _config.yml can be found here.